Ein Changelog ist die geführte Liste aller Änderungen einer Software, nach Fassungen geordnet. Er liegt im Repository, meist als Datei namens CHANGELOG.md, und wächst mit jeder Veröffentlichung von oben.
- Changelog
Die geführte Liste aller Änderungen einer Software, nach Fassungen geordnet.
Beispiel: „Der Changelog nannte für 3.0 vier entfernte Funktionen, und genau die waren im Einsatz.“Auf Deutsch Änderungsprotokoll. Die verbreitete Gliederung stammt aus der Konvention Keep a Changelog: hinzugefügt, geändert, veraltet, entfernt, behoben, Sicherheit.
Abgrenzung zu den Release Notes: Diese wählen für Nutzer aus. Der Changelog ist die vollständige Liste in technischer Sprache.
Wie ein Changelog aufgebaut ist
Neueste Fassung oben, je Fassung die Nummer, das Datum und die Änderungen nach Art gruppiert. Dazu gehört ein Abschnitt für das, was seit der letzten Veröffentlichung dazugekommen ist und noch keine Nummer hat.
Jeder Eintrag ist ein Satz in der Gegenwart und nennt die Wirkung. Ein Verweis auf das Ticket oder den Pull Request daneben macht aus der Zeile einen Einstieg in die Einzelheiten.
Woher die Einträge kommen
Entweder von Hand oder aus den Commits. Wer seine Commit-Nachrichten nach einer Konvention schreibt, lässt ein Werkzeug den Changelog daraus erzeugen; das ist bequem und liefert Zeilen, die nach Code klingen.
Von Hand gepflegt liest sich die Liste besser und bleibt kürzer. Für eine Website hat sich bei uns der Mittelweg bewährt: erzeugte Rohliste, einmal durchgesehen vor der Veröffentlichung.
Was ein Changelog bei einem Update wert ist
Die Antwort auf die Frage, was der Sprung kostet. Zwischen zwei Hauptfassungen stehen dort die entfernten Funktionen, und genau an denen hängt die Arbeit, nicht an der neuen Nummer.
Deshalb gehört der Changelog vor jedes größere Update gelesen, zusammen mit der Liste der eigenen Erweiterungen. Fünf Minuten dort ersparen den Abend, an dem nach dem Update die halbe Seite fehlt.