Implementieren eines Änderungsprotokolls
Das Konzept eines Änderungsprotokolls ist einfach: Es handelt sich um eine Datei mit einer Liste von Änderungen, die an einem Projekt vorgenommen wurden, in der Regel in der Datumsreihenfolge. Die typische Aufschlüsselung besteht in der Trennung einer Liste von Versionen, die dann innerhalb jeder Version angezeigt wird:
- Hinzugefügte Features
- Geänderte/verbesserte Features
- Gelöschte Features
Einige Teams veröffentlichen Änderungsprotokolle als Blogbeiträge. Andere erstellen eine CHANGELOG.md-Datei in einem GitHub-Repository.
Automatisierte Änderungsprotokolltools
Obwohl Änderungsprotokolle erstellt und manuell verwaltet werden können, sollten Sie die Verwendung eines automatisierten Tools zum Erstellen von Änderungsprotokollen in Betracht ziehen. Zumindest als Ausgangspunkt.
Verwenden von nativen GitHub-Befehlen
Der Git-Protokollbefehl kann zum automatischen Erstellen von Inhalten nützlich sein. Beispiel: Erstellen eines neuen Abschnitts pro Version:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Git-Änderungsprotokoll
Ein Standardtool ist gitchangelog. Dieses Tool basiert auf Python.
Generator für das GitHub-Änderungsprotokoll
Ein weiteres Tool heißt github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Dieses Tool basiert auf Gem.
Sollten Sie automatisch generierte protokollbasierte Daten verwenden?
Es soll grundsätzlich vermieden werden, Protokolleinträge in einem Änderungsprotokoll abzuladen. Protokolle enthalten in der Regel viele Einträge, was schnell zu Unordnung führen kann, die nicht hilfreich ist.