Publication

Public(s) concerné(s) : Gestionnaire d’application openMairie.

Le référencement

Lorsque la première version stable et ré-utilisable est prête, il est important de la publier:

Sur la forge Adullact, pour le projet :

• la première fois :
  • ajouter un « onglet utilisateur » nommé SIte Web sur openmairie.org et pointant via un hyperlien vers http://www.openmairie.org/catalogue/<code du projet>
  • on peut également ajouter des onglets pour faire le lien vers le forum ou la documentation, mais ils seront redondants avec ceux du portail openMairie
• à chaque version :
  • mettre à jour les élements de l’onglet Outils de suivi: bugs, évolutions, feuille de route
  • sous l’onglet Fichiers, ajouter un livrable sous forme d’archive zip

Sur le portail openMairie, pour le projet, demander à :

• la première fois :
  • ajouter l’application au catalogue avec un <code du projet> à reprendre dans l’hyper-lien de la forge
  • définir pour cette application
    • les hyper-liens vers: la documentation, la démonstration, le livrable, le forum, la feuille de route, la forge, …
    • le logo
    • les caractéristiques techniques: version courante, type de base, version framework, utilisation PostGIS, …
• à chaque version :
  • mettre à jour le catalogue si besoin: description de l’application
  • mettre à jour la fiche de l’application: version, liens …

La documentation

Lorsqu’il y a une nouvelle version de l’application et que la version majeure ou mineure est incrémentée, il faut ajouter une nouvelle version de la documentation aussi.

Voici la liste des étapes à reproduire :

Sur GitHub :

• ajouter une nouvelle branch en reprenant la version majeure et mineure pour la nommer ;
• dans le readme de la documentation, modifier les versions ;
• dans le fichier source/conf.py, modifier les variables project, copyright, version et release ;
• dans le fichier source/index.rst, modifier le titre de la documentation ;
• dans settings, modifier la branche par défaut pour mettre la nouvelle.

Sur readthedoc :

• dans le menu admin, puis version, changer la version par défaut ;
• désactiver la version stable et latest.

Depuis l’URL docs.openmairie.org faire un « refresh » pour mettre à jour la page de présentation des documentations : http://docs.openmairie.org/?refresh

Dans l’application :

• modifier le lien dans les fichiers dyn/footer.inc.php et doc/index.php pour pointer vers la nouvelle URL.

Le site de démonstration

Lorsqu’il y a une nouvelle version de l’application et que la version majeure ou mineure est incrémentée, il est conseillé de mettre la version de la démonstration à jour aussi.

Voici la liste des étapes à reproduire sur GitLab :

La première fois :

• cloner le dépôt de paramétrage du déploiement des démonstrations https://gitlab.com/openmairie/d.openmairie.org
• dans le fichier ./demonstration.inc.php, ajouter un sous-tableau à $demo pour votre application
  • indexer ce sous-tableau avec le même code projet que celui utilisé sur le portail
  • renseigner le sous-tableau par analogie avec les autres
• ajouter le fichier ./demonstration_data/openmarcheforain.sql
  • ce fichier permet d’exécuter des instructions SQL après le passage du fichier install.sql pour adapter les données de démonstration
  • on conseille d’y écrire DELETE FROM om_droit WHERE libelle='password'; pour éviter qu’un utilisateur ne modifie les mots de passe et rende la démonstration inutilisable jusqu’au prochain re-déploiment
• Proposer ces modifications par un PULL-REQUEST
• Une fois intégrées au dépôt officiel, ces modifications seront déployer le soir vers 22h

Les fois suivantes :

• mettre à jour ou recloner le dépôt
• mettre à jour les fichiers:
  • ./demonstration.inc.php
  • ./demonstration_data/openmarcheforain.sql