This project provides a simple way to create a markdown ordered list of issues and pull requests closed with a given milestone on GitHub.
The script ensures that any special characters that might break the generated links are scrubbed and substituted with the corresponding HTML entities; as such, the script should be generally usable unattended.
This is a fork of phly/changelog-generator for use with more recent versions of PHP and various quality-of-life improvements.
Use Composer to install dependencies:
$ composer require akrabat/changelog-generator
This will install the script in
You can also install globally using:
composer global require akrabat/changelog-generator
and ensure that
~/.composer/vendor/bin is on your PATH. The script is then available using
There are two primary ways to use the generator:
- Use CLI options to pass in configuration
- Create a configuration file, and pass that to the script
The standard CLI options are:
- -t or --token, to pass your GitHub API token
- -u or --user, to pass your GitHub username or organization
- -r or --repo, to pass your GitHub repository name
- -m or --milestone, to pass the identifier of the GitHub milestone for which to generate the changelog
As an example:
vendor/bin/changelog_generator.php -t MYgithubAPItoken -u weierophinney -r changelog_generator -m 1 > changelog.md
Alternately, create a configuration file. You can use
config/config.php.dist as a template; it simply needs to return an array with the keys "token", "user", "repo", and "milestone". You then pass this to the script:
vendor/bin/changelog_generator.php -c path/to/config.php
You can also mix-and-match options -- for instance, you might place your token in a configuration file, and then pass the other options via CLI.
Additional CLI options control the output:
- -g or --group-labels, to display the result grouped by labels
- -o or --plain-text-output, to display the milestone titles as plain text, rather than HTML encoded