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

Add list of alternative changelogs

Browse Source
This commit is contained in:
Petr Korolev 2015-02-18 11:20:47 +02:00
parent eac2cf5a65
commit 2f3bb3f7a5
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -41,16 +41,29 @@ Changelog generation has never been so easy.
###Features and advantages of this project as compared to other: ###Features and advantages of this project as compared to other:
- Custom date format supported
- 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) - 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 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) - Ability to exclude some issues from changelog (by labels)
###Alternatives:
- [https://github.com/piwik/github-changelog-generator](https://github.com/piwik/github-changelog-generator) - just simple list of closed issues
- [example](https://github.com/piwik/github-changelog-generator/blob/master/screenshot.png)
- [https://github.com/tschaub/github-changelog](https://github.com/tschaub/github-changelog) - generator based on JS
- without any links and separation lists
- [example](https://github.com/tschaub/github-changelog/blob/master/changelog.md)
- [https://github.com/walmartlabs/generator-release](https://github.com/walmartlabs/generator-release) - most advanced, looks very similar to mine, but:
- without oath token (so, you can't make more that 50 requests)
- no label-filtering and sparate lists and other option.
- lack of customisation abilites
- buggy, missed some issues
- [Example](https://github.com/walmartlabs/generator-release/blob/master/release-notes.md)
## Usage: ## Usage:
**It's really simple**: **It's really simple**: