Git-Release-Notes erstellen

Fügen Sie Commit-Nachrichten oder einen Unified Diff ein. Der Entwurf enthält eine Versionsstufe anhand der Commit-Markierungen; prüfen Sie diese vor der Veröffentlichung.

Läuft lokal in deinem Browser
Dieses Werkzeug verarbeitet alle Daten lokal in deinem Browser.
Commits oder Git-DiffFügen Sie Conventional Commits, Git-Log-Betreffzeilen oder Unified-Diff-Text ein.
Markdown-Release-Entwurf
Führe das Werkzeug aus, um das lokal verarbeitete Ergebnis hier anzuzeigen.

So entwerfen Sie Release Notes aus Commits oder einem Diff

Fügen Sie Conventional-Commit-Betreffzeilen ein — gern direkt aus git log --oneline — oder einen Unified Diff, und die Seite macht daraus einen Markdown-Entwurf mit gruppierten Änderungen und einem vorgeschlagenen Level major, minor oder patch.

Hier wird kein Repository angefasst: Der eingefügte Text wird im Browser ausgewertet, die Beispiel-Schaltfläche füllt ein Muster ein, und Kopieren oder Herunterladen geben den Entwurf als release-notes.md heraus.

  1. Fügen Sie den Text in Commits oder Git-Diff ein: eine Conventional-Commit-Betreffzeile pro Zeile, eine git-log---oneline-Liste oder Unified-Diff-Ausgabe mit diff --git-Köpfen.
  2. Drücken Sie Release Notes erzeugen. Zeilen, die keine Commit-Betreffzeilen oder Diff-Inhalte sind — Autor, Datum, Hunk-Marker — werden übersprungen.
  3. Lesen Sie den Entwurf: Commits werden unter Funktionen, Fehlerbehebungen, Performance, Geändert, Dokumentation, Tests sowie Build und CI gruppiert, und jeder Commit mit ! oder BREAKING-CHANGE-Fußzeile wird markiert.
  4. Prüfen Sie das vorgeschlagene Level: major bei einer markierten inkompatiblen Änderung, minor sobald ein feat dabei ist, sonst patch. Der Entwurf nennt es Vorschlag, weil die endgültige Versionsnummer Ihre Entscheidung ist.
  5. Kopieren oder Herunterladen holen das Ergebnis; Leeren leert beide Felder.

Was diese Seite liest und was Sie entscheiden

Was erkannt wird

Commit-Betreffzeilen dürfen ein kurzes oder langes Hash-Präfix tragen, abc1234 feat: … und ein voller 40-Zeichen-Hash werden also als Commits gelesen. Ein Scope bleibt erhalten: feat(api): add filters landet unter Funktionen mit dem Scope in Klammern.

Die Typliste ist der Conventional-Commits-Satz — feat, fix, docs, style, refactor, perf, test, build, ci, chore — plus revert. Diff-Eingaben brauchen echte diff --git-Köpfe: Dateiliste und + / −-Zeilenzahlen stammen nur aus Zeilen nach einem Kopf, ein einzelnes + im Fließtext zählt also nicht als Ergänzung.

Das Versions-Level ist ein Vorschlag

major = mindestens ein ! oder eine BREAKING-CHANGE-Fußzeile; minor = mindestens ein feat; patch = alles andere, einschließlich docs, Tests, style und chore. Das sind mechanische Regeln — lesen Sie den Entwurf, bevor Sie eine Version taggen.

Die Vorschlagszeile ist einfacher Text im Entwurf, und nichts wird irgendwo veröffentlicht: Diese Seite erzeugt nur die Ausgabe.

Was diese Seite nicht tut

Sie liest kein Git-Repository, führt kein git aus und ruft keinen Netzwerkdienst auf: Ausgewertet wird nur der eingefügte Text.

Formate außerhalb dieser beiden werden gemeldet statt geraten: Ein leeres Feld antwortet mit dem Einfüge-Hinweis, und Text ohne Commit-Betreffzeile und Diff-Inhalt bekommt eine eigene Meldung. git diff --stat-Zusammenfassungen und binäre Diffs werden nicht in Zeilenstatistiken umgerechnet.

Zuletzt verwendet: