Changelogs und Release Notes erstellen
Lernen Sie, wie Sie aus Ihrer Git-Historie und Conventional Commits übersichtliche Changelogs und automatisierte Release Notes erstellen.
Changelogs und Release Notes erstellen ist eine kostenlose DevOps Bootcamp-Lektion auf CoddyKit. Dies ist Lektion 4 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des DevOps Bootcamp-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der DevOps Bootcamp-Kurs umfasst insgesamt 4 Lektionen.
Was ist ein Changelog?
Ein Changelog ist eine redaktionell gepflegte, für Menschen lesbare Liste der wichtigsten Änderungen für jede Version. Er befindet sich in einer Datei wie CHANGELOG.md im Stammverzeichnis des Repositorys.
Warum Changelogs wichtig sind
Benutzer und Teammitglieder lesen Changelogs, um Folgendes zu verstehen:
- neue Funktionen
- Fehlerbehebungen
- Breaking Changes
Sie machen Upgrades sicherer und schneller.
Keep-a-Changelog-Format
Eine gängige Konvention gruppiert Einträge unter Überschriften: Added, Changed, Fixed, Removed.
## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bugConventional Commits
Conventional Commits verwenden Präfixe wie feat:, fix: und BREAKING CHANGE:, sodass Tools Changelogs automatisch erstellen können.
feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 supportCommits seit einem Tag auflisten
Mit git log und einem Tag-Bereich können Sie eine Vorschau der Änderungen seit dem letzten Release anzeigen.
git log v1.1.0..HEAD --onelineFormatierte Log-Ausgabe für Notizen
Formatieren Sie das Log in Form von Aufzählungszeilen, die sich für Release Notes eignen.
git log v1.1.0..HEAD --pretty=format:'- %s'Tools für automatisierte Changelogs
Tools wie standard-version oder conventional-changelog lesen Conventional Commits und erzeugen den Changelog sowie eine Versionsaktualisierung.
npx standard-versionAutomatisch generierte GitHub-Notizen
GitHub kann beim Erstellen eines Releases automatisch Release Notes aus zusammengeführten Pull Requests generieren.
gh release create v1.2.0 --generate-notesKategorisierung mit Labels
Eine Datei .github/release.yml ordnet PR-Labels den Changelog-Abschnitten zu, sodass Fehlerbehebungen und Funktionen automatisch gruppiert werden.
changelog:
categories:
- title: Features
labels: [feature]Vor der Veröffentlichung prüfen
Lesen Sie generierte Notizen vor der Veröffentlichung immer durch. Die Automatisierung erstellt einen Entwurf, aber eine Person überarbeitet die Formulierungen und hebt Breaking Changes hervor.
Mit Releases verknüpfen
Verknüpfen Sie jeden Changelog-Eintrag mit seinem Git-Tag und seiner Release-Seite, damit Leser direkt zum exakten Diff springen können.
[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0Kurzer Check
Testen Sie Ihr Verständnis von Changelogs und Release Notes.
Zusammenfassung
Sie haben gelernt, Changelogs zu generieren:
- Verwenden Sie das Keep-a-Changelog-Format
- Conventional Commits ermöglichen die Automatisierung
git log v1..HEADzeigt eine Vorschau der Änderungengh release create --generate-noteserstellt aus PRs einen Entwurf der Notizen
Häufig gestellte Fragen
Ist die Lektion „Changelogs und Release Notes erstellen“ kostenlos?
Ja — der vollständige Text von „Changelogs und Release Notes erstellen“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des DevOps Bootcamp-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der DevOps Bootcamp-Kurs umfasst insgesamt 4 Lektionen.
Was lerne ich in „Changelogs und Release Notes erstellen“?
Lernen Sie, wie Sie aus Ihrer Git-Historie und Conventional Commits übersichtliche Changelogs und automatisierte Release Notes erstellen. Du übst DevOps Bootcamp mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.
Brauche ich Erfahrung, um DevOps Bootcamp zu starten?
Keine Vorkenntnisse erforderlich. DevOps Bootcamp auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 4 von 4.
Wie lange dauert die Lektion „Changelogs und Release Notes erstellen“?
Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.
Kann ich in dieser DevOps Bootcamp-Lektion Code schreiben und ausführen?
Ja. Jede DevOps Bootcamp-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.
Alle Lektionen in diesem Kurs
- Semantische Versionierung mit Tags
- Releases erstellen und verwalten
- Release-Branches und Hotfixes
- Changelogs und Release Notes erstellen