Pull-request based conventional changelog generator for GitHub projects which follow the AngularJS Commit Message Format.
- Releases are published to GitHub
- Docker images automatically built at Docker Hub
It should be started with a edn config file with the following content:
{:user "user"
:repo "repo"
:token "0123456789abcdef0123456789abcdef01234567"}Then start with:
$ java -cp github-changelog.jar clojure.main -m github-changelog.cli config.edn
This will clone the user/repo repository from GitHub into the current directory and will generate the changelog for it.
You could also pass in a configuration on stdin if you set the config filename to -.
Here is an example usage:
$ java -cp github-changelog.jar clojure.main -m github-changelog.cli - < config.edn
$ cat config.edn | docker run -i --rm whitepages/github-changelog -
| key | description | required |
|---|---|---|
:user |
Username for the repo | ✓ |
:repo |
Repository name | ✓ |
:token |
GitHub access token to reach the API | ✗ |
:github |
GitHub URL | ✗ |
:github-api |
URL for GitHub Enterprise API | ✗ |
:jira |
JIRA URL if you're using that for issue tracking | ✗ |
:dir |
The destination directory for the repo | ✗ |
:update? |
Clones or fetches the repository before generating the changelog | ✗ |
:git-url |
Git URL for cloning if automatic generation does not suit you | ✗ |
A more complete config example:
{:user "user"
:repo "repo"
:token "0123456789abcdef0123456789abcdef01234567"
:github "https://github.example.com/"
:github-api "https://github.example.com/api/v3/"
:jira "https://jira.atlassian.com/"
:dir "/tmp/destination-dir/"
:update? false}Can be found here CHANGELOG.md
Copyright © 2015-2019 Whitepages Inc.
Distributed under MIT license.