Changelog Generator
Füge deine Commit-Nachrichten ein, zum Beispiel die Ausgabe von git log --oneline --decorate, und erhalte eine aufgeräumte CHANGELOG.md. Conventional-Commit-Typen werden in Hinzugefügt, Geändert, Behoben und die anderen Keep-a-Changelog-Abschnitte einsortiert, Tags werden zu Versionen, und für unveröffentlichte Arbeit wird die nächste semantische Version vorgeschlagen.
Zuletzt aktualisiert:
Tipp: Füge die Ausgabe von git log --oneline --decorate ein (Tags werden zu Versionen) oder git log --format="%h %ad %d %s" --date=short, um Datumsangaben einzuschließen.
Anleitung: Changelog Generator
- Hol dir deine Commits: Führe
git log --oneline --decorateaus (oder mit--format="%h %ad %d %s" --date=shortfür Datumsangaben) und kopiere die Zeilen seit dem letzten Release. - Füge sie in das linke Feld ein, die neuesten zuerst, so wie Git sie ausgibt. Zum Start wird ein Beispiel geladen.
- Wähle das Format: Keep a Changelog oder Conventional, und entscheide, ob Wartungs- und nicht konventionelle Commits einbezogen werden.
- Prüfe die Version: Übernimm den vorgeschlagenen Semver-Sprung, gib deine eigene ein oder lass neue Commits unter „Unveröffentlicht“.
- Füge deine Repository-URL hinzu für klickbare Commit- und Vergleichslinks und kopiere oder lade dann die CHANGELOG.md herunter.
Conventional-Commit-Typen und wohin sie gehören
| Commit | Keep-a-Changelog-Abschnitt | Conventional-Abschnitt | Versionssprung |
|---|---|---|---|
feat: CSV-Export hinzufügen | Hinzugefügt | Features | Minor |
fix: leere Eingabe abfangen | Behoben | Bugfixes | Patch |
fix(deps): patch CVE-2024-1234 | Sicherheit | Bugfixes | Patch |
perf: geparste Abfragen cachen | Geändert | Leistungsverbesserungen | Patch |
refactor: split scheduler | Geändert | Code-Refactoring | Patch |
feat: deprecate /v1/reports | Veraltet | Features | Minor |
feat!: remove v1 endpoints | Entfernt (als BREAKING markiert) | Features + ⚠ Breaking Changes | Major |
docs, chore, ci, test, build, style | Geändert (nur wenn eingeschlossen) | Eigene Abschnitte (nur wenn eingeschlossen) | Patch |
Update README (nicht konventionell) | Geändert (wenn eingeschlossen) | Sonstige Änderungen (wenn eingeschlossen) | Patch |
Die richtigen Commits aus Git holen
git log --oneline --decorategibt eine Zeile pro Commit mit Tags wie(tag: v1.4.0)aus, die zu Versionsüberschriften werden.git log --format="%h %ad %d %s" --date=shortergänzt das Commit-Datum, das als Release-Datum jeder getaggten Version dient.git log v1.4.0..HEAD --onelinelistet nur die Commits seit dem letzten Release auf, ideal für den nächsten Abschnitt.git log --no-mergeslässt Merge-Commits von vornherein weg (der Generator überspringt sie ohnehin).
Einen Changelog schreiben, den Leute wirklich lesen
- Schreibe Commit-Betreffs im Imperativ („add“, „fix“, „remove“) und beschreibe die Wirkung für Nutzer, nicht die Codeänderung.
- Bearbeite den erzeugten Text vor der Veröffentlichung: Fasse zusammengehörige Einträge zusammen, streiche interne Details und ergänze Migrationsschritte für Breaking Changes.
- Setze das neueste Release nach oben und datiere jede Version im ISO-Format (YYYY-MM-DD), damit die Reihenfolge weltweit eindeutig ist.
- Sammle kommende Arbeit unter Unveröffentlicht und benenne den Abschnitt in die Versionsnummer um, wenn du das Release taggst.
Häufige Fragen
Welche Eingabe erwartet der Changelog Generator?
Einen Commit-Betreff pro Zeile, die neuesten zuerst, genau so, wie git log ihn ausgibt. Ein kurzer oder vollständiger Hash am Zeilenanfang wird erkannt, ebenso Datumsangaben im Format YYYY-MM-DD und Tag-Dekorationen wie (tag: v1.4.0). Eingerückte Zeilen nach einem Commit gelten als dessen Body, sodass ein Footer BREAKING CHANGE: erkannt wird. Eine Zeile, die nur eine Version enthält, etwa v1.4.0 oder ## 1.4.0, beginnt ebenfalls eine neue Version.
Wie werden Conventional-Commit-Typen den Keep-a-Changelog-Abschnitten zugeordnet?
feat kommt zu Hinzugefügt, fix zu Behoben, und perf, refactor, revert und andere Typen zu Geändert. Commits, deren Beschreibung mit deprecate beginnt, kommen zu Veraltet, solche mit remove oder drop zu Entfernt, und Fixes, die Security, eine CVE oder eine Sicherheitslücke erwähnen, zu Sicherheit. Breaking Changes werden in ihrem Abschnitt als BREAKING markiert.
Wie wird die nächste Versionsnummer gewählt?
Sie folgt Semantic Versioning ausgehend vom neuesten Tag in deiner Liste: Jeder Breaking Change erhöht die Major-Version, sonst erhöht jedes feat die Minor-Version, sonst steigt die Patch-Version. Vor 1.0.0 erhöht ein Breaking Change stattdessen die Minor-Version, eine gängige Konvention für die erste Entwicklungsphase. Du kannst jederzeit deine eigene Version eingeben.
Warum fehlen einige Commits im Changelog?
Merge-Commits werden immer übersprungen, weil sie die Arbeit anderer Commits wiederholen. Commits vom Typ docs, chore, ci, test, build oder style sind standardmäßig ausgeblendet, weil sie Nutzer selten interessieren; hake die Option an, um sie einzuschließen. Breaking Changes werden immer angezeigt, egal welchen Typ sie haben.
Was ist Keep a Changelog?
Keep a Changelog ist eine weit verbreitete Konvention für menschenlesbare Changelogs: die neueste Version zuerst, eine Überschrift pro Release mit Datum, Änderungen gruppiert unter Hinzugefügt, Geändert, Veraltet, Entfernt, Behoben und Sicherheit sowie ein Abschnitt „Unveröffentlicht“ für kommende Arbeit. Sie passt natürlich zu Semantic Versioning.
Funktioniert es mit GitLab- und GitHub-Links?
Ja. Gib die Repository-URL ein, und der Generator verlinkt Commit-Hashes, Issue-Verweise wie #123 und Versionsvergleiche nach den URL-Mustern von GitHub oder GitLab, die anhand der Adresse erkannt werden. Ohne URL bleibt der Changelog reiner Text.
Werden meine Commit-Nachrichten irgendwohin gesendet?
Nein. Analyse und Formatierung finden in deinem Browser statt, sodass der Verlauf privater Repositories auf deinem Gerät bleibt.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.