Implémenter un journal des modifications
Le concept de journal des modifications est assez simple : il s’agit d’un fichier qui contient une liste des modifications apportées à un projet, généralement dans l’ordre chronologique. La décomposition classique consiste à séparer une liste de versions, puis, dans chaque version, à indiquer les éléments suivants :
- Fonctionnalités ajoutées
- Fonctionnalités modifiées/améliorées
- Fonctionnalités supprimées
Certaines équipes postent les journaux de modifications sous forme de billets de blog ; d’autres créent un fichier CHANGELOG.md dans un dépôt GitHub.
Outils de création de journal des modifications automatisés
Les journaux de modifications peuvent être créés et gérés manuellement, mais vous pouvez également utiliser un outil de création de journal des modifications automatisé, du moins comme point de départ.
Utilisation de commandes GitHub natives
La commande de journal Git peut être utile pour créer du contenu automatiquement. Par exemple, pour créer une section par version :
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Journal des modifications Git
gitchangelog fait partie des outils standard. Il est basé sur Python.
Générateur de journaux de modifications GitHub
Le générateur de journaux de modifications GitHub, appelé github-changelog-generator, est un autre outil standard.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Il est basé sur Gem.
Devez-vous utiliser des données de journal générées automatiquement ?
Il est toujours préférable d’éviter de vider les entrées d’un journal des modifications. Les journaux génèrent du bruit et deviennent souvent désordonnés, ce qui ne simplifie pas les choses.