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

update

Browse Source
This commit is contained in:
Petr Korolev 2015-03-18 15:43:11 +02:00
parent 4162bc8659
commit a514224625
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -22,7 +22,7 @@ GitHub Changelog Generator
**Fully automate changelog generation** - This gem generate change log file based on **tags**, **issues** and merged **pull requests** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker.
Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release!
Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! :tada:
### *What’s the point of a change log?*
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
@ -129,11 +129,11 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
- 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) :negative_squared_cross_mark:
- **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors:
- **Distinguish** bug fixes, enchantments, and closed issues **according labels**.
- Merged pull-requests (all merged pull-requests)
- Bug-fixes (by label `bug` in issue)
- Enhancements (by label `enhancement` in issue)
- Issues (closed issues w/o any labels)
- **Distinguish** bug fixes, enchantments, and closed issues **according labels**. :mag_right:
- Merged pull-requests (all merged pull-requests) :twisted_rightwards_arrows:
- Bug-fixes (by label `bug` in issue) :beetle:
- Enhancements (by label `enhancement` in issue) :star2:
- Issues (closed issues w/o any labels) :non-potable_water:
- You manualy can set which labels should be included/excluded and apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)*