Skip to content

Commit

Permalink
docs: updates README with labels details and installation
Browse files Browse the repository at this point in the history
  • Loading branch information
bartoszmajsak committed Dec 11, 2019
1 parent ade8485 commit 36c6812
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
= GitHub Changelog Generator

Generates changelog from commits.
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 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`

0 comments on commit 36c6812

Please sign in to comment.