Implémenter un journal des modifications
Le concept d’un journal des modifications est assez simple : il s’agit d’un fichier qui a une liste de modifications apportées à un projet, généralement dans l’ordre de date. La répartition classique consiste à séparer une liste de versions, puis dans chaque version, afficher :
- Fonctionnalités ajoutées
- Fonctionnalités modifiées/améliorées
- Fonctionnalités supprimées
Certaines équipes publient des journaux de modification en tant que billets de blog ; d’autres créent un fichier CHANGELOG.md dans un dépôt GitHub.
Outils de journal des modifications automatisés
Bien que les journaux de modification puissent être créés et gérés manuellement, vous pouvez envisager d’utiliser un outil de création de journal de modification automatisé. Au moins comme point de départ.
Utilisation de commandes GitHub natives
La commande git log peut être utile pour créer automatiquement du contenu. 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 standard est gitchangelog. Cet outil est basé sur Python.
Générateur de journal des modifications GitHub
Un autre outil standard est appelé github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Cet outil est basé sur Gem.
Devez-vous utiliser des données basées sur des journaux générés automatiquement ?
Il est préférable de toujours éviter de transférer les entrées de journal dans le journal des modifications. Les journaux sont « bruyants », il est donc facile de générer un désordre qui n'est d'aucune utilité.