An open API service indexing awesome lists of open source software.

https://github.com/bartoszmajsak/github-changelog-generator


https://github.com/bartoszmajsak/github-changelog-generator

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

= GitHub Changelog Generator

Generates changelog from Pull Requests merged since last release.

[source,bash]
----
ghc generate --repository bartoszmajsak/github-changelog-generator
----

== Labels

Pull Requests will be grouped by labels defined for them. There are two special labels which are handled differently:

* `skip-changelog` if present on the PR, it will not be included in the list
* `dependencies`, if PR is titled `"build(deps): bump lib from X to Y"` will only include the latest update in case of many since last release

== Installation

Get latest `ghc` binary using simple download script:

[source,bash]
----
curl -sL http://git.io/install-ghc | bash
----

TIP: You can also specify the version and directory before downloading `curl -sL http://git.io/install-ghc | bash -s -- --version=v0.0.1 --dir=~/bin`