Eine Changelog für seine Erweiterung generieren

Hallo Entwickler.
Mir ging es letztens so, dass ich bei einem meiner Module nicht mehr wusste, wann ich ein bestimmtes Feature implementiert hatte.
Durch die Tickets der Meilensteine auf GitHub durchzuwühlen fand ich mühsam.

Eine Changelog muss her.
Bei der Recherche danach fand ich einige Generatoren, jedoch nicht so nach meinen Vorstellungen.

• einen Release basierenden, dazu muss eine Release Note eingetragen werden, Datumsbezogene Zuordnung der Tickets
• einen Tag basierenden, Datumsbezogene Zuordnung der Tickets

Da ich Release mit Release Notes nicht pflege, und ein nachträgliches pflegen die Datumswerte durcheinanderbringt fiel die Sache aus.
Ebenfalls TAG basierend, da es mir öfters passiert, das ich das eine oder andere Ticket erst schließe wenn der Tag bereits generiert ist. Dadurch rutscht das Ticket plötzlich in die nächste TAG Ausgabe.
Eines glaube eines nimmt sogar jedes Commit :mad:.

Was blieb war also einen selber zu basteln.

Mein Tool ist Meilenstein basierend und dessen Tickets darin. Es sucht auch Labels darin, wichtig! Siehe Handbuch.
Es generiert eine Markdown Datei, default ist CHANGELOG.md.

Es ist logischerweise kein Contao Modul. Daher muss man sich einfach die ZIP Datei von Github laden und ensprechend installieren.

Quelle mit kurzer Anleitung: https://github.com/BugBuster1701/bb_changelog_gen
Handbuch, etwas ausführlicher, derzeit nur de: http://docs.contao.ninja/de/github-c...generator.html
Und so sieht eine Changelog dann aus: https://github.com/BugBuster1701/bb_...r/CHANGELOG.md

Installiert man das ganze wie beschrieben hat man ein neues "git" Kommando: git generate-changelog ..... :D

Achja, die install.sh geht von Linux Umgebung aus. Aber auch ohne Aufruf install.sh kann man den Generator nutzen, siehe Anleitung.

Die eine oder andere Verbesserung habe ich noch im Kopf, Ideen könne gern als Ticket hinterlassen werden, aber keine Garantie auf Umsetzung. ;)

Viel Spaß damit, falls es noch jemand ausser meiner einer nutzen wird.

PS: Wie man den richtigen Zeitpunkt findet die zu generieren steht im Handbuch. Die soll ja schließlich aktuell in der jeweiligen Version mit enthalten sein.

Coole Sache! Da ich vor dem ähnlichen Problem stehe, dass ich nachträglich einige Changelogs erstellen möchte, genau das richtige für mich. Wobei ich auf den in deiner README verlinkten skywinder/github-changelog-generator setzen werde.

So, Handbuch gibt's nun auch auf Englisch, ich hoffe jedenfalls das ist englisch was ich da getippt habe :-)
https://t.co/xfeDnGVoHI

Eine neue Version ist da. Auszug aus der eigenen Changelog:

Code:

---

Version 1.2.0 (2015-11-08)

New features
    #18 Translate install.sh messages
    #17 Add uninstall.sh
    #16 New Label Mapping Type: Maintenance
    #15 New Label Mapping Type: Documentation

Fixed bugs
    #20 404 Not Found abfangen

Documentation improvements
    #22 Documentation new features
    #21 Hint: Needs allow_url_fopen = On
    #19 Hint: sudo in install.sh

Maintenance case
    #23 Code Verbesserungen

---

Quelle mit kurzer Anleitung: https://github.com/BugBuster1701/bb_changelog_gen
Handbuch, etwas ausführlicher: http://docs.contao.ninja/de/github-c...generator.html