kunstmaan/github-flow-changelog

Command to generate a changelog based on Github milestones and pull requests

dev-master 2022-10-06 09:02 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.0.1
• http-interop/http-factory-guzzle: ^1.0
• knplabs/github-api: ^3.0
• symfony/console: ^6.1

MIT

• Roderik van der Veer

README

Installation

git clone https://github.com/Kunstmaan/github-flow-changelog.git
cd github-flow-changelog
composer install

Or install it globally.

composer global require kunstmaan/github-flow-changelog:@dev

Make sure you have your path configured correctly. See https://getcomposer.org/doc/03-cli.md#global for more information.

Running

./gfc <github token> <organisation/user> <repository> > CHANGELOG.md

Generate a token here

Example

./gfc changelog xxx Kunstmaan KunstmaanBundlesCMS > ~/Development/KunstmaanBundlesCMS/CHANGELOG.md

Output

Check out this changelog