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-03-17 17:07:12 +02:00
parent 947163426b
commit 0e0295645d
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -116,19 +116,19 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
##Features and advantages of this project ##Features and advantages of this project
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) - Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
- Simply add links for all closed issues and merged pull requests
- Possible to generate **Unreleased** changes (closed issues that have not released yet) - Possible to generate **Unreleased** changes (closed issues that have not released yet)
- Flexible format customisation: - **GitHub Enterprise support** via command line options!
- Customize issues, that should be added to changelog - Flexible format **customisation**:
- Custom date format supported - **Customize** issues, that **should be added** to changelog
- **Custom date format** supported
- 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 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 specific issues from change log (by labels) - Ability to **exclude specific issues** from change log (by labels)
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels)
- Distinguish bug fixes, enchantments, and closed issues according labels. - **Distinguish** bug fixes, enchantments, and closed issues **according labels**.
- **Issues** (closed issues w/o any labels) - Issues (closed issues w/o any labels)
- **Merged pull-requests** (all merged pull-requests) - Merged pull-requests (all merged pull-requests)
- **Bug-fixes** (by label `bug` in issue) - Bug-fixes (by label `bug` in issue)
- **Enhancements** (by label `enhancement` in issue) - Enhancements (by label `enhancement` in issue)
###Alternatives ###Alternatives
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements. Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements.