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

Merge branch 'master' into develop

Browse Source
This commit is contained in:
Petr Korolev 2015-02-24 15:15:00 +02:00
commit 1d8b1f40b5
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -5,6 +5,12 @@
- *Merged pull-request:* Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder)) - *Merged pull-request:* Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
- *Implemented enhancement:* Not Released [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
- *Fixed bug:* Test pull request with invalid label \(#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17) ## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)

15
README.md
View File

@ -10,7 +10,7 @@ GitHub Changelog Generator
- [Usage](#usage) - [Usage](#usage)
- [Params](#params) - [Params](#params)
- [GitHub token](#github-token) - [GitHub token](#github-token)
- [Features and advantages of this project as compared to other](#features-and-advantages-of-this-project-as-compared-to-other) - [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives) - [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library) - [Projects using this library](#projects-using-this-library)
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature) - [Am I missed some essential feature?](#am-i-missed-some-essential-feature)
@ -107,16 +107,19 @@ So, if you got error like this:
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP. It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
##Features and advantages of this project as compared to other ##Features and advantages of this project
- Generate cannonical changelog file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
- Support **Unreleased** issues (closed issues that have not yet released)
- 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 exclude specific issues from changelog (by labels)
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that should'n be in changelog file: with `duplicate invalid wontfix` labels)
- Automatically split issues by type - Automatically split issues by type
- **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)
- Excluding "questions" from changelog (issues marked as `question` labels)
- 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 exclude specific issues from changelog (by labels)
###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.