Ein Änderungsprotokoll implementieren

  • 3 Minuten

Ein Änderungsprotokoll ist einfach: Es handelt sich um eine Datei, in der Änderungen aufgelistet werden, die an einem Projekt vorgenommen wurden, normalerweise nach Datum organisiert. Das typische Format zeigt Versionen und listet für jede Version Folgendes auf:

  • Hinzugefügte Features – Neue Möglichkeiten
  • Geänderte/verbesserte Features – Dinge, die besser funktionieren
  • Gelöschte Features – Elemente, die entfernt wurden

Einige Teams veröffentlichen Änderungsprotokollen als Blogbeiträge. Andere erstellen eine CHANGELOG.md Datei in ihrem GitHub-Repository.

Automatisierte Änderungsprotokoll-Tools

Zwar können Sie Änderungsprotokollen manuell erstellen und verwalten, sie können aber auch ein automatisiertes Tool verwenden, um Ihnen zu helfen. Zumindest als Ausgangspunkt.

Verwenden von systemeigenen Git-Befehlen

Mit dem git log Befehl können Sie Inhalte automatisch erstellen. Erstellen Sie z. B. einen neuen Abschnitt pro Version:

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

Git-Änderungsprotokoll

Ein beliebtes Tool ist gitchangelog. Dieses Tool wird in Python geschrieben.

GitHub-Änderungsprotokoll-Generator

Ein weiteres beliebtes Tool wird github-changelog-generator genannt.

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

Dieses Tool basiert auf Ruby Gem.

Sollten Sie automatisch generierte protokollbasierte Daten verwenden?

Es ist in der Regel besser, Log-Einträge nicht einfach in ein Änderungsprotokoll zu kopieren. Protokolle enthalten zu viele technische Details, daher ist es einfach, ein verwirrendes Chaos zu erstellen, das benutzern nicht hilft, zu verstehen, was sich geändert hat.