Contribute Media
A thank you to everyone who makes this possible: Read More

Comment gérer un changelog facilement quand on est plusieurs ?

Description

Gérer un changelog utile pour les utilisateurs·trices d'une application/bibliothèque n’est pas facile.

Les messages de commit sont à destination des développeurs·euses et peuvent difficilement être utilisés comme changelog cohérent pour une version. Mettre à jour un fichier unique CHANGELOG.md semble une solution simple… sauf quand on commence à travailler à plusieurs, avec des branches, rebases, merges et autres conflits possibles.

Je propose d’expliquer une solution que j’ai mise en place dans un outil en Python (ezchlog [easy changelog]) qui permet de résoudre cette problématique en utilisant de petits fichiers changelog qui se fusionneront dans le fichier général quand on le veut (lors d’une version par exemple).

L’outil est en Python 3.9+, typé, testé avec une couverture de +90% et entièrement configurable.

P.S. : J’ai également développé le même outil en Rust et je peux brièvement parler des différences de développement si ça intéresse du monde.

Details

Improve this page