Was macht Changelog Generator?
Automatisch benutzerfreundliche Changelogs aus der Git-Historie generieren. Folgt dem Keep a Changelog-Format, poliert Commit-Nachrichten in eine benutzerfreundliche Sprache und erstellt optional GitHub Releases.
Eingabeauflösung
Die primäre Eingabe ist ein Git-Ref-Bereich. Löse das Argument (falls angegeben) folgendermaßen auf:
- Enthält
...oder..-> Git-Ref-Bereich (z.B.v1.0.0...v1.1.0) - Passt zu einem einzelnen Tag/Ref -> von jenem Ref bis HEAD
- Passt zu einer GitHub-URL oder einem
#\d+-Muster -> PR (nur Änderungen aus diesem PR extrahieren). Bei Einzel-PR-Eingabe: Lies den PR-Diff und die Beschreibung, kategorisiere die Änderungen, verwende den PR-Titel als Eintrag. Überspringe den Versions-Header. Frage den Benutzer, ob diese Einträge an eine vorhandene Changelog-Version angehängt oder eine neue erstellt werden soll. - Kein Argument -> frage: „Welchen Bereich soll der Changelog abdecken? Du kannst einen Git-Ref-Bereich (z.B. v1.0.0...v1.1.0), einen Tag (Änderungen seit diesem Tag) oder eine PR-Nummer angeben.“
Prozessablauf
digraph changelog {
rankdir=TB;
"Eingabe auflösen" [shape=box];
"Phase 1: Sammeln" [shape=box];
"Phase 2: Kategorisieren" [shape=box];
"Phase 3: Polieren" [shape=box];
"Phase 4: Überprüfen" [shape=box];
"Bestätigt?" [shape=diamond];
"Phase 5: Ausgabe" [shape=box];
"Eingabe auflösen" -> "Phase 1: Sammeln";
"Phase 1: Sammeln" -> "Phase 2: Kategorisieren";
"Phase 2: Kategorisieren" -> "Phase 3: Polieren";
"Phase 3: Polieren" -> "Phase 4: Überprüfen";
"Phase 4: Überprüfen" -> "Bestätigt?";
"Bestätigt?" -> "Phase 3: Polieren" [label="Überarbeitungen"];
"Bestätigt?" -> "Phase 5: Ausgabe" [label="Ja"];
}
Überspringe keine Phasen. Stelle Fragen in einem natürlichen Tempo. Wenn der Benutzer mehrere auf einmal beantwortet, akzeptiere gebündelte Antworten und springe vorwärts.
Wenn der Benutzer „wähle einfach Standardeinstellungen“ oder ähnliches sagt, wähle vernünftige Standardeinstellungen, teile mit, was du gewählt hast, und bitte um eine einzige Bestätigung.
Phase 1: Sammeln
Schritt 1 – Commits und PRs sammeln
Führe git log zwischen den beiden Ref-Punkten aus, um alle Commits zu sammeln. Wenn das Repository PRs verwendet, suche auch nach gemergten PRs im Bereich mit gh pr list --state merged.
Extrahiere für jeden Commit/PR:
- Commit-Nachricht (Betreff + Textkörper)
- Geänderte Dateien (zur Bestimmung des Umfangs)
- PR-Titel und -Beschreibung (falls verfügbar)
- Jegliches Prefix für konventionelle Commit-Typen (feat, fix, chore, usw.)
Schritt 2 – Weiteren Produktkontext lesen
Lese, falls vorhanden: README, package.json (oder Äquivalent). Ziel: verstehen, was das Produkt ist, um benutzerfreundliche Beschreibungen zu schreiben.
Wenn nichts gefunden wird, frage: „Kannst du das Produkt kurz beschreiben? Ich brauche Kontext, um benutzerfreundliche Changelog-Einträge zu schreiben.“
Schritt 3 – Vorhandenes Format erkennen
Überprüfe, ob das Repository eine vorhandene CHANGELOG.md hat. Wenn ja:
- Erkenne das Format (Keep a Changelog, benutzerdefiniert, usw.)
- Erkenne, ob Emoji-Labels (z.B. Emojis für Neu, Bug-Fix, Breaking) oder reine Textkategorien verwendet werden
- Passe dich dem vorhandenen Stil an
Wenn kein vorhandener Changelog:
- Standardmäßig das Keep a Changelog-Format verwenden
- Frage: „Kein vorhandener Changelog gefunden. Bevorzugst du Emoji-Labels (z.B. für Neu, Bug-Fix) oder reine Textkategorien (Hinzugefügt, Behoben, usw.)?“
Phase 2: Kategorisieren
Sortiere alle Änderungen in Keep a Changelog-Kategorien. Breaking Changes erhalten einen eigenen Abschnitt ganz oben:
- Breaking Changes – jede Änderung, die bestehendes Verhalten, APIs bricht oder eine Benutzeraktion zum Upgrade erfordert. Füge für jede eine Migrationsanleitung hinzu. Erkenne an
feat!:,fix!:,BREAKING CHANGE:-Fußzeilen oder entfernten/umbenannten APIs im Diff. - Hinzugefügt – neue Funktionen
- Geändert – Änderungen an bestehender Funktionalität
- Veraltet – Funktionen, die entfernt werden
- Entfernt – Funktionen, die entfernt wurden
- Behoben – Bug-Fixes
- Sicherheit – Schwachstellenbehebungen
Kategorisierungsregeln:
- Folgen Commits konventionellen Commits (
feat:,fix:, usw.), verwende den Typ zur Kategorisierung - Wenn nicht, analysiere den Diff und die Commit-Nachricht, um die Kategorie zu bestimmen
- Überspringe reine Interne-Änderungen (Refactorings, Test-Ergänzungen, CI-Änderungen, Abhängigkeits-Upgrades), sofern sie das benutzerseitige Verhalten nicht beeinflussen
- Bei Unsicherheit, ob eine Änderung benutzerseitig ist, nimm sie auf und lass den Benutzer sie bei der Überprüfung entfernen
- Für Bereiche mit 50+ Commits fasse zusammenhängende Änderungen zu übergeordneten Einträgen zusammen (z.B. statt 12 einzelner API-Fixes schreibe „Verbesserte API-Fehlerbehandlung über mehrere Endpunkte hinweg“). Präsentiere die zusammengefasste Version und lass den Benutzer jede Gruppe erweitern, wenn er Details wünscht.
Präsentiere die kategorisierte Liste:
„Hier ist, was ich in diesem Bereich gefunden habe:“
Hinzugefügt (3)
- Funktion A
- Funktion B
- Funktion C
Behoben (2)
- Bug-Fix A
- Bug-Fix B
„Möchtest du etwas hinzufügen, entfernen oder umkategorisieren?“
Fahre NICHT fort, bis der Benutzer bestätigt.
Phase 3: Polieren
Schreibe jeden Eintrag in benutzerfreundliche Sprache um:
- Beginne mit dem Nutzen für den Benutzer, nicht mit dem Implementierungsdetail
- „Berichte laden jetzt 3× schneller“, nicht „Optimierter SQL-Abfrage-Ausführungsplan für das Berichtsmodul“
- „Du kannst Berichte jetzt als PDF exportieren“, nicht „PDF-Export-Funktionalität zum Berichtsdienst hinzugefügt“
- Halte jeden Eintrag auf eine Zeile (maximal zwei für komplexe Änderungen)
- Füge PR/Issue-Referenzen ein, wo verfügbar (z.B.
(#123))
Versions-Header
Format: ## [Version] - YYYY-MM-DD
Wenn die obere Grenze des Bereichs ein Versions-Tag ist (z.B. v1.2.0), verwende dies als Version. Wenn die obere Grenze HEAD oder ein Branchname ist, frage: „Welche Versionsnummer soll dieser Changelog verwenden?“
Verwende das Datum des jüngsten Commits im Bereich, im ISO-Format (YYYY-MM-DD).
Technischer Anhang
Nach dem Erstellen des benutzerfreundlichen Changelogs frage:
„Möchtest du, dass ich auch einen technischen Anhang mit Implementierungsdetails erstelle? (nützlich für entwicklerorientierte Dokumentation)“
Wenn ja, erstelle einen detaillierteren Abschnitt mit technischen Einzelheiten, Breaking-Change-Migrationsanleitungen und API-Änderungen.
Schreibregeln
- Verwende niemals Gedankenstriche im generierten Inhalt. Keine „---“-Zeichen. Verwende stattdessen Kommas, Doppelpunkte, Punkte oder Klammern.
- Standardmäßig benutzerfreundliche Sprache (kein Jargon, keine internen Funktionsnamen)
- Ein Eintrag pro Zeile, maximal zwei für komplexe Änderungen
- Konsistente Verb-Zeitform (Vergangenheit: „Hinzugefügt“, „Behoben“, „Entfernt“)
- PR/Issue-Referenzen einfügen, wo verfügbar
Phase 4: Überprüfen
Präsentiere den vollständigen Changelog-Eintrag:
„Hier ist der Changelog:“
## [1.2.0] - 2026-04-11 ### Hinzugefügt - Du kannst Berichte jetzt als PDF exportieren (#123) ### Behoben - Dashboard flackert nicht mehr beim Laden der Seite (#456)„Möchtest du Änderungen?“
Warte auf Freigabe. Fahre nur mit der Ausgabe fort, wenn der Benutzer bestätigt.
Phase 5: Ausgabe
CHANGELOG.md
Erkenne vorhandene CHANGELOG.md im Repository-Root. Wenn gefunden, lies die gesamte Datei, identifiziere den Einfügepunkt (vor der ersten ## [-Zeile), präsentiere dem Benutzer den vorgeschlagenen Einfügepunkt und bestätige vor dem Schreiben. Wenn nicht gefunden, erstelle eine mit einem Standard-Header:
# Changelog
Alle wichtigen Änderungen an diesem Projekt werden in dieser Datei dokumentiert.
Das Format basiert auf [Keep a Changelog](https://keepachangelog.com/).
Bestätige immer vor dem Schreiben:
„Ich werde dies an den Anfang von
CHANGELOG.mdsetzen. Alles klar?“
GitHub Release
Nach dem Speichern des Changelogs frage:
„Möchtest du, dass ich auch ein GitHub Release mit diesem Changelog erstelle?“
Wenn ja, verwende gh release create <Tag> --notes "<Changelog-Inhalt>", um das Release zu erstellen. Wenn gh nicht verfügbar ist, informiere den Benutzer und überspringe diesen Schritt.
Fehlerbehandlung
ghnicht verfügbar -> Benutzer informieren, PR-Anreicherung und GitHub Release überspringen, sich nur auf Git-Log verlassen- Ungültiger Ref/Tag -> Benutzer bitten, zu überprüfen
- Keine Commits im Bereich -> Benutzer informieren, bitten, den Bereich zu überprüfen
- Kein Produktkontext -> Benutzer bitten, das Produkt zu beschreiben
- Nicht-konventionelle Commits -> Zurückfallen auf Diff-Analyse zur Kategorisierung
Was dieses Skill NICHT tut
- Versionsstrategie verwalten (Entscheidungen über semantische Versionierung liegen beim Benutzer)
- In Paketregister veröffentlichen
- Blogbeiträge oder Newsletter generieren (verwende
/blog-postoder/newsletter) - Branching-Strategien oder Release-Workflows handhaben