Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 3.6 KB

README.md

File metadata and controls

88 lines (59 loc) · 3.6 KB

GitHub changelog

Continuous Integration status Docker Build Status Docker pulls GitHub license

Pull-request based conventional changelog generator for GitHub projects which follow the AngularJS Commit Message Format.

Releases and Dependency Information

  • Releases are published to GitHub
  • Docker images automatically built at Docker Hub

Usage

Jar

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

Docker image

$ cat config.edn | docker run -i --rm whitepages/github-changelog -

Config options

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}

Changes and example output

Can be found here CHANGELOG.md

Copyright and License

Copyright © 2015-2019 Whitepages Inc.

Distributed under MIT license.