Een wijzigingenlogboek implementeren

  • 3 minuten

Een wijzigingslogboek is eenvoudig: het is een bestand met wijzigingen die zijn aangebracht in een project, meestal geordend op datum. In de gebruikelijke indeling worden versies weergegeven en voor elke versie worden de lijsten getoond:

  • Toegevoegde functies - Nieuwe dingen die u kunt doen
  • Gewijzigde/verbeterde functies - Dingen die beter werken
  • Verwijderde functies - Items die zijn verwijderd

Sommige teams posten wijzigingenlogboeken als blogberichten. Anderen maken een CHANGELOG.md-bestand in hun GitHub-opslagplaats.

Geautomatiseerde hulpprogramma's voor wijzigingenlogboeken

Hoewel u wijzigingenlogboeken handmatig kunt maken en onderhouden, kunt u een geautomatiseerd hulpprogramma gebruiken om u te helpen. Ten minste als uitgangspunt.

Systeemeigen Git-opdrachten gebruiken

Met de git log opdracht kunt u automatisch inhoud maken. Maak bijvoorbeeld een nieuwe sectie per versie:

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

Git-wijzigingslogboek

Een populair hulpprogramma is gitchangelog. Dit hulpprogramma is geschreven in Python.

GitHub wijzigingenlog-generator

Een ander populair hulpprogramma wordt github-changelog-generator genoemd.

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

Dit hulpprogramma is gebaseerd op Ruby Gem.

Moet u automatisch gegenereerde logboekgegevens gebruiken?

Het is meestal beter om te voorkomen dat alleen logboekvermeldingen in een wijzigingenlogboek worden gekopieerd. Logboeken bevatten te veel technische details, dus het is eenvoudig om een verwarrende rommel te maken die gebruikers niet helpt te begrijpen wat er is gewijzigd.