generated from bartoszmajsak/template-golang
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: updates README with labels details and installation
- Loading branch information
1 parent
ade8485
commit 36c6812
Showing
1 changed file
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |