CHANGELOG.md-Vorlagengenerator
Generieren Sie Keep-a-Changelog-kompatible CHANGELOG.md-Vorlagen mit semantischen Versionsgruppen, unveröffentlichten Protokollen und automatisierten Git-Tag-Vergleichsreferenzen.
Fill in your project name, repository link, and release version logs to export a Keep-a-Changelog standard markdown document.
Display name of your application.
A brief, one-sentence tagline.
Required to generate Git tag comparison links.
Determines formatting structure and links.
Release Version History & Logs
Warum sollten Sie unseren CHANGELOG.md-Vorlagengenerator verwenden?
- Keep-a-Changelog-Standard: Stellen Sie die strikte Einhaltung der Spezifikationen sicher. Unser Tool generiert Standard-Änderungsprotokolle der Version 1.1.0, die ordnungsgemäß geordnete Standard-Semantikkategorien enthalten.
- Automatisierte Vergleichslinks: Erhöhen Sie die Glaubwürdigkeit des Repositorys. Geben Sie unten Ihre GitHub-Repository-URL an, um automatisch Vergleichsreferenz-URLs zwischen allen Tags zu erstellen.
- Mehrere Ausgabeformate: Holen Sie sich das Format, das zu Ihrem Workflow passt. Exportieren Sie als Keep-a-Changelog-Markdown, als Common Changelog-Aufzählungszeichen oder als sauberen GitHub-Versionshinweis-Markdown.
- 100 % kundenseitiger Datenschutz: Schützen Sie Ihre Projektdetails. Der Generator verarbeitet alle Formularparameter, Freigabeprotokolle und das Rendern von Vorlagen lokal in Ihrem Webbrowser.
Was ist der Keep-a-Changelog-Standard?
Keep a Changelog ist eine weit verbreitete Community-Spezifikation, die eine einheitliche, für Menschen lesbare Struktur für Projektänderungsprotokolle festlegt. Anstatt alle Updates in einer einzigen umfangreichen Aufzählungsliste zusammenzufassen, definiert der Standard streng sechs semantische Gruppen: **Hinzugefügt, Geändert, Veraltet, Entfernt, Behoben und Sicherheit**. Diese kategorisierte Gruppierung macht es Entwicklern, Managern und Endbenutzern unglaublich einfach, Ihre Versionshinweise zu scannen und wichtige Funktionserweiterungen, veraltete Warnungen oder Sicherheitsupdates schnell zu finden.
Warum Git-Commit-Logs kein Ersatz für Changelogs sind
Viele Entwickler legen ihre rohen Git-Protokolle fälschlicherweise direkt in einer Textdatei ab und nennen sie Changelog. Git-Protokolle sind jedoch für **Maschinen und Compiler** konzipiert und mit Mikro-Commits, Tippfehlerkorrekturen, Merge-Branch-Protokollen und Code-zentrierten Notizen gefüllt. Ein professionelles Changelog ist für **Menschen** konzipiert. Es kuratiert diese Commits, filtert nicht-konsequente Aktualisierungen heraus und übersetzt Rohänderungen in klare, benutzerorientierte Beschreibungen. Handschriftliche Protokolle stellen sicher, dass Entwickler lesen und verstehen können, was neu ist und welche Auswirkungen es auf ihre Integration hat.
Die Grundprinzipien der semantischen Versionierung (SemVer)
Die Einhaltung der semantischen Versionierung stellt die Grundlage für stabile Software-Ökosysteme dar. Eine SemVer-Versionsnummer ist als Major.Minor.Patch strukturiert (z. B. 1.2.3). Die **PATCH**-Version wird erhöht, wenn Sie abwärtskompatible Fehlerbehebungen veröffentlichen. Die **MINOR**-Version wird erhöht, wenn Sie neue, abwärtskompatible Funktionen hinzufügen. Die **MAJOR**-Version ist für fehlerhafte API-Änderungen reserviert, die eine Aktualisierung der Integrationen durch Benutzer erfordern. Durch die Verfolgung dieser Versionen in einem strukturierten Änderungsprotokoll bleiben Ihre Abhängigkeiten sicher und transparent.
Die Leistungsfähigkeit automatisierter Git-Vergleichslinks
Ein wirklich professionelles Changelog listet nicht nur Versionen auf, sondern verbindet sie. Durch das Einfügen von Vergleichslinkreferenzen am Ende Ihrer Datei können Benutzer auf eine beliebige Versionsnummer klicken, um den genauen Codeunterschied zwischen der aktuellen Version und dem vorherigen Tag auf GitHub anzuzeigen. Dieser Generator kompiliert diese Vergleichsreferenzlinks automatisch basierend auf Ihrer Repository-URL. Es ordnet nachfolgende Versionen den GitHub-Vergleichsverzeichnissen zu und markiert die erste Version korrekt, wodurch das Vertrauen und die Transparenz der Entwickler gestärkt werden.
Häufig gestellte Fragen
Der CHANGELOG.md-Vorlagengenerator ist ein kostenloses Online-Tool, das automatisch produktionsbereite, Keep-a-Changelog-kompatible CHANGELOG.md-Dateien erstellt. Es unterstützt benutzerdefinierte Release-Elemente, unveröffentlichte Abschnitte und automatisierte Git-Vergleichslinks.
Die Spezifikation definiert genau sechs Kategorien, um alle Codeänderungen zu gruppieren: Hinzugefügt (neue Funktionen), Geändert (Änderungen vorhandener Funktionen), Veraltet (bald entfernte Funktionen), Entfernt (gelöschte Funktionen), Behoben (Fehlerbehebungen) und Sicherheit (Patches und Sicherheitsverbesserungen).
Durch die Bereitstellung Ihrer GitHub-Repository-URL kompiliert der Generator automatisch Markdown-Vergleichsreferenzen am Ende der Datei. Durch Klicken auf den Header einer Release-Version gelangen Benutzer direkt zur GitHub-Diff-Vergleichsansicht, in der Änderungen zwischen dem aktuellen Release-Tag und dem vorherigen Tag angezeigt werden.
Git-Commit-Protokolle sind technisch, ausführlich und für Maschinen gedacht. Ein handgeschriebenes Änderungsprotokoll wird speziell für menschliche Leser zusammengestellt. Es filtert triviale Commits heraus, gruppiert Änderungen in saubere semantische Kategorien und erklärt den tatsächlichen Nutzen oder die tatsächliche Auswirkung der Änderungen.
Das Tool bietet ein für GitHub Releases spezifisches Markdown-Format, das Header-Metadaten und Referenzlinks entfernt. Dies stellt saubere, nach Emojis gruppierte, kopier- und einfügbare Aufzählungslisten bereit, die sich zum direkten Einfügen in GitHub/GitLab-Release-Dashboards eignen.
Ja! Sie können jedes Standard-Tag für die semantische Version angeben, einschließlich Vorabversions-Tags wie 1.0.0-beta.1 oder 1.0.0-rc.2. Das Validierungssystem verarbeitet es korrekt gemäß der SemVer 2.0.0-Spezifikation.
Ja, 100 %. Die gesamte Verarbeitung und Vorlagenkompilierung erfolgt lokal in Ihrem Webbrowser mithilfe von clientseitigem JavaScript. Es werden niemals Umgebungsvariablen, Porteinstellungen, geheime Schlüssel oder Codefragmente an einen Server übertragen oder hochgeladen, wodurch vollständiger Datenschutz gewährleistet ist.