Een wijzigingslogboek implementeren

3 minuten

Het concept van een wijzigingslogboek is eenvoudig genoeg: het is een bestand met een lijst met wijzigingen in een project, meestal in datumvolgorde. De typische uitsplitsing is om een lijst met versies te scheiden en vervolgens binnen elke versie weer te geven:

Toegevoegde functies
Gewijzigde/verbeterde functies
Verwijderde functies

Sommige teams zullen wijzigingenlogboeken posten als blogberichten; anderen maken een CHANGELOG.md-bestand in een GitHub-opslagplaats.

Geautomatiseerde hulpprogramma's voor wijzigingenlogboeken

Hoewel wijzigingenlogboeken kunnen worden gemaakt en handmatig kunnen worden onderhouden, kunt u overwegen om een geautomatiseerd hulpprogramma voor het maken van wijzigingenlogboeken te gebruiken. Ten minste als uitgangspunt.

Systeemeigen GitHub-opdrachten gebruiken

De git-logboekopdracht kan handig zijn voor het automatisch maken van inhoud. Voorbeeld: maak een nieuwe sectie per versie:

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

Git-wijzigingslogboek

Eén standaardhulpprogramma is gitchangelog. Dit hulpprogramma is gebaseerd op Python.

GitHub changelog generator

Een ander standaardhulpprogramma wordt github-changelog-generator genoemd .

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

Dit hulpprogramma is gebaseerd op Gem.

Moet u automatisch gegenereerde logboekgegevens gebruiken?