numerique-gouv / b3desk

BBB frontend by the French Ministry of Education
https://b3desk.readthedocs.io
Other
8 stars 1 forks source link

Fournir des notes de version #100

Open azmeuk opened 5 months ago

azmeuk commented 5 months ago

Générer un fichier de notes de version, accessible dans la documentation du projet. Le but est d'informer les personnes qui déploient le projet des changements relatifs à la base de données (et donc prévoir des migrations), aux configuration (et donc prévoir de mettre à jour les fichiers de configuration), et lister les nouvelles fonctionnalités et corrections.

Il existe des outils dans github (exemple) et aussi dans l'écosystème python. C'est probablement intéressant de se baser sur un de ces outils.

Si les notes de versions sont ajoutées au fil de l'eau dans un fichier CHANGELOG comme c'est souvent l'usage, ça risque de générer beaucoup de conflits sur les PR. Ces outils de versionnage permettent d'éviter ça en compilant les notes de versions au dernier moment, à partir de fichiers dédiés.