Implémenter un journal des modifications

  • 3 minutes

Un journal des modifications est simple : il s’agit d’un fichier qui répertorie les modifications apportées à un projet, généralement organisés par date. Le format classique affiche les versions, et pour chacune, liste :

  • Ajout de fonctionnalités - Nouvelles choses que vous pouvez faire
  • Fonctionnalités modifiées/améliorées - Les éléments qui fonctionnent mieux
  • Fonctionnalités supprimées - Éléments qui ont été supprimés

Certaines équipes publient des journaux de modification sous forme de billets de blog. D’autres créent un fichier CHANGELOG.md dans leur dépôt GitHub.

Outils de journal des modifications automatisés

Bien que vous puissiez créer et gérer manuellement des journaux de modification, vous pouvez utiliser un outil automatisé pour vous aider. Au moins comme point de départ.

Utilisation de commandes Git natives

La git log commande peut vous aider à créer du contenu automatiquement. Par exemple, créez une section par version :

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Journal des modifications Git

Un outil populaire est gitchangelog. Cet outil est écrit en Python.

Générateur de journal des modifications GitHub

Un autre outil populaire est appelé github-changelog-generator.

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

Cet outil est basé sur Ruby Gem.

Devez-vous utiliser des données de journal générées automatiquement ?

Il est généralement préférable d’éviter simplement de copier des entrées de journal dans un journal des modifications. Les journaux contiennent trop de détails techniques. Il est donc facile de créer un désordre confus qui n’aide pas les utilisateurs à comprendre ce qui a changé.