Entwerfen Sie ein Änderungsprotokoll aus Commits
Changelog draft liest die Commits des ersten übergeordneten Elements zwischen zwei Punkten, gruppiert sie, schlägt eine nächste Version vor und ermöglicht das Kopieren von Markdown. In der Notiz heißt es, dass es sich nur um einen Entwurf handelt. Nichts wird markiert, freigegeben oder gepusht. Sie überprüfen die Nachrichten, bevor Sie sie teilen.
Funktioniert in GitTree Kostenlos: alle lokalen Git-Funktionen, kein Konto erforderlich.
Auf dieser Seite
Bevor Sie beginnen
- Der Änderungsprotokollentwurf ist Teil des kostenlosen Plans. Beide Endpunkte müssen bereits Commits sein. Der Dialog sagt Choose both committed endpoints, bis sie es sind.
- Nachrichten, die Sie gruppieren möchten, sollten auf Conventional Commits (
feat:,fix:,feat!:) folgen. Einfache Nachrichten werden zur Überprüfung gezählt. Es handelt sich nicht um erfundene Kategorien.
Wo es zu finden ist
- Das Menü eines Commits oder eines Tags: Changelog draft.
Alt+Loder die Befehlspalette.
| Aktion | macOS | Windows und Linux |
|---|---|---|
| Changelog draft | ⌥L | Alt+L |
| Die Befehlspalette | ⌘⇧P | Ctrl+Shift+P |
Schritte
Öffnen Sie den Changelog-Entwurf
Wählen Sie den Commit aus, der den Bereich beenden soll, oder das Tag, für das Sie Notizen schreiben, und wählen Sie Changelog draft. Sie können auch
Alt+Ldrücken. Der Titel ist Changelog draft. In der Notiz steht Draft only. Review commit messages before sharing. Nothing is published.
Der Changelog-Entwurf befindet sich in diesem Menü und im Menü eines Tags. Das Standbild zeigt das Commit-Menü.GitTree-Schnittstelle mit einem Demonstrations-Repository. Legen Sie den Bereich fest
From (excluded) ist der Commit oder Tag, den Sie bereits veröffentlicht haben. To (included) ist der neue Tipp. In der Scope-Zeile heißt es, dass der Entwurf die Historie des ersten Elternteils verwendet. Commits, die nur durch eine Zusammenführung eingegangen sind, werden durch den Zusammenführungs-Commit dargestellt und nicht einzeln aufgelistet.
Erzeugen Sie den Entwurf
Drücken Sie Generate draft. Stop fordert den Abschluss des gelesenen Verlaufs an. Der Entwurf erscheint unter Editable Markdown draft, mit Suggested version, wenn eine Version vorgeschlagen werden kann, und Baseline tag, wenn ein Versions-Tag auf den ausgeschlossenen Endpunkt verweist. Copy Markdown kopiert es. Markdown copied bestätigt die Kopie.
Bearbeiten Sie und entscheiden Sie dann, wohin es geht
Bearbeiten Sie den Markdown im Feld. Replace draft with proposal setzt den generierten Text nach der Bearbeitung zurück. Wenn Sie die Endpunkte ändern, sagt GitTree, dass die Endpunkte geändert wurden und Ihr bearbeiteter Entwurf erhalten bleibt. Insert draft into release notes wird angeboten, wenn Sie Notizen für eine Veröffentlichung schreiben. Wenn Sie nach der Bearbeitung schließen, werden Sie gefragt, ob Sie zuerst Discard edited draft? Kopieren möchten, wenn Sie die Wörter benötigen.
Erwartetes Ergebnis
Sie haben Markdown in der Zwischenablage oder im Feld „Versionshinweise“. Es wurde kein Tag erstellt und keine Veröffentlichung veröffentlicht. Lesen Sie die Gruppen, bevor Sie sie in eine Version einfügen. Einfache Nachrichten, Rücksetzungen und Zusammenführungen werden angezeigt, damit Sie sie neu schreiben können.
Wie Commits gruppiert werden
| Gruppe | Was dort platziert ist |
|---|---|
| Bahnbrechende Veränderungen | Als fehlerhaft markierte Commits, einschließlich einer !- oder einer BREAKING CHANGE-Fußzeile |
| Funktionen | feat-Commits |
| Korrekturen | Commits reparieren |
| Leistung | Perf-Commits |
| Andere | Erkannte Typen, die nicht zu den oben genannten gehören, und Nachrichten, die noch überprüft werden müssen |
Die Zählzeile ist Needs review, mit einfachen Nachrichten, Rücksetzungen, Zusammenführungen und nicht dekodierbaren Nachrichten. Aufgrund dieser Zahlen kann eine Version zurückgehalten werden. No commits in this range; no release is proposed bedeutet, dass die Endpunkte jedes Commit ausschließen.
Wie die vorgeschlagene Version ausgewählt wird
Der Vorschlag beginnt mit einem Versions-Tag auf dem ausgeschlossenen Endpunkt. Der Dialog erklärt den Grund: Breaking Changes deuten auf eine Hauptversion oder eine Nebenversion hin, während die Hauptversion Null ist. Features lassen auf ein Moll schließen. Andere anerkannte Conventional Commits schlagen einen Patch vor. Sie können den Vorschlag ignorieren. Choose the next version after review erscheint, wenn GitTree keinen auswählt.
git log --first-parent --pretty=format:%s v1.2.0..HEAD
git tag --points-at v1.2.0^{}Der gleiche Bereich in einem Terminal beträgt git log --first-parent vom ausgeschlossenen Commit bis zum enthaltenen Tipp. GitTree führt git tag nicht für Sie aus. Das Erstellen des Tags ist tags. Das Veröffentlichen von Notizen auf einem Host ist eine separate Freigabeaktion. Die Tutorial-Lektion zu Tags zeigt, wie ein Tag einen Commit benennt.
Es wird nichts veröffentlicht
Copy Markdown kopiert nur Text. Insert draft into release notes füllt ein Feld. Weder wird ein Tag, noch ein GitHub-Release oder ein Push erstellt. Wenn das Kopieren fehlschlägt, wird im Dialogfeld Could not copy. Select and copy the draft text. angezeigt. Ihr bearbeiteter Entwurf bleibt in der Box, bis Sie ihn ersetzen oder verwerfen.
Wenn etwas schief geht
„Wählen Sie beide committeten Endpunkte.“
Von oder Bis ist noch kein Commit. Wählen Sie zwei Commits oder ein Tag aus, das auf einen Commit verweist. Ein Zweigname, der nicht aufgelöst wird, wird nicht generiert.
„Keine Versions-Tag-Punkte am ausgeschlossenen Endpunkt.“
Es gibt nichts zu erhöhen. Wählen Sie selbst die nächste Version aus oder markieren Sie zuerst den ausgeschlossenen Commit und generieren Sie ihn erneut.
„Unterschiedliche Versions-Tags verweisen auf den ausgeschlossenen Endpunkt. Wählen Sie die Basisversion.“
Auf diesem Commit befindet sich mehr als ein Versions-Tag. Wählen Sie die Grundlinie aus, die Sie meinen. GitTree wird nicht erraten, welches Tag die Produktversion ist.
„Die Basislinie ist eine Vorabversion. Wählen Sie den Veröffentlichungskanal und die Version.“
Ein Prerelease-Tag impliziert nicht die nächste stabile Nummer. Wählen Sie den Kanal und die Version aus und behalten Sie dann den Entwurf.
„Konnte nicht kopiert werden. Wählen Sie den Entwurfstext aus und kopieren Sie ihn.“
Die Zwischenablage wurde abgelehnt. Wählen Sie den Markdown im Feld aus und kopieren Sie ihn mit der Systemverknüpfung. Der Entwurf ist noch da.
Fragen
Erstellt der Changelog-Entwurf eine Veröffentlichung?
Nein. In der Notiz steht, dass nichts veröffentlicht wird. Sie kopieren Markdown oder fügen es in Versionshinweise ein. Sie taggen und veröffentlichen sich selbst.
Welche Commits sind enthalten?
Verlauf des ersten Elternteils vom ausgeschlossenen Endpunkt bis einschließlich des Trinkgeldes. Die Commits eines zusammengeführten Zweigs werden durch den Merge-Commit dargestellt.
Warum gibt es keine empfohlene Version?
Der Dialog hält einen zurück, wenn das Baseline-Tag fehlt, mehrdeutig ist oder eine Vorabversion vorliegt, wenn einfache Nachrichten, Rücksetzungen, Zusammenführungen oder nicht dekodierbare Nachrichten überprüft werden müssen oder wenn eine Versionskomponente nicht erhöht werden kann.
Werden meine Änderungen einen neuen Bereich überleben?
Ja, bis Sie sie ersetzen. Im Dialogfeld wird angezeigt, dass Ihr bearbeiteter Entwurf erhalten bleibt. „Entwurf durch Vorschlag ersetzen“ überschreibt ihn mit dem neuen Text.
Muss ich Conventional Commits verwenden?
Nein. Einfache Nachrichten werden unter „Überprüfung erforderlich“ aufgeführt. Die Gruppen und die vorgeschlagene Version sind spezifischer, wenn Probanden feat, fix und den Breaking-Change-Marker verwenden.