README.md

BugBuster's GitHub Changelog Generator

Generiert eine Changelog Datei im Markdown Format von deinem Repository auf GitHub, basierend auf Milestones und dessen Issues.

Gesucht werden alle Meilensteine mit mindestens einem geschlossenen Ticket.

Inspiriert von

• ins0/github-changelog-generator (Release basierend)
• skywinder/github-changelog-generator (Tag basierend)

Installation

Download von GitHub und entpacken.

Aufruf der install.sh, diese kopiert Dateien nach /usr/local/[lib|bin|man]. Dazu werden sudo Rechte benötigt.

Deinstallation

Aufruf der uninstall.sh, diese löscht die Dateien aus /usr/local/[lib|bin|man]. Dazu werden sudo Rechte benötigt.

Anforderungen

• PHP 5.4.0 or higher
• allow_url_fopen = On

Nutzung

git generate-changelog -u [username] -r [repository]

Optionale Parameter: -t [token] -l [label] -f [filepath]

Nutzung ohne Aufruf von install.sh

php ./lib/bb_changelog_gen-cli.php -u [username] -r [repository]

Optionale Parameter: -t [token] -l [label] -f [filepath]

GitHub Token

GitHub erlaubt nur 50 Abfragen ohne Authentifizierung. Daher sollte mit dem Parameter -t [40-stelliger-Token] gearbeitet werden.

Es kann auch die Umgebungsvariable GITHUB_CHANGELOG_GENERATOR_TOKEN gesetzt werden:

export GITHUB_CHANGELOG_GENERATOR_TOKEN="40-stelliger-Token"

Beispielsweise in der Datei ~/.bashrc.

Einen Token kann hier generiert werden.

Ausgabe Beispiel

Siehe Changelog von diesem Projekt.