will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Petr Korolev 2015-02-02 17:09:30 +02:00
parent 91c34e7f98
commit c06c0f0432
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -13,6 +13,20 @@ You're almost done!
[sudo] gem install github_changelog_generator [sudo] gem install github_changelog_generator
#Features
- **Fully automate changelog generation** - all you need to do - is close issue or merge pull-request by **Github issue tracker**
- Automatically split issues by type:
- **Issues** (closed issues w/o any labels)
- **Merged pull-requests** (all merged pull-requests)
- **Bug-fixes** (by label `bug` in issue)
- **Enhancements** (by label `enhancement` in issue)
- Excluding "questions" from changelog (issues marked as `question` labels)
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
- Ability to exclude some issues from changelog (by labels)
## Usage ## Usage
**It's really simple**: **It's really simple**: