update
This commit is contained in:
parent
260e3bd666
commit
32e085965c
38
README.md
38
README.md
|
@ -6,14 +6,20 @@ GitHub Changelog Generator
|
||||||
|
|
||||||
Changelog generation has never been so easy.
|
Changelog generation has never been so easy.
|
||||||
|
|
||||||
This script automatically generate change-log from your tags and merged pull-requests.
|
**Fully automate changelog generation** - This script automatically generate change-log from your tags, issues and merged pull-requests from your project's **Github issue tracker**.
|
||||||
|
|
||||||
## Installation:
|
## Installation:
|
||||||
You're almost done!
|
|
||||||
|
|
||||||
[sudo] gem install github_changelog_generator
|
[sudo] gem install github_changelog_generator
|
||||||
|
|
||||||
## Example:
|
## Output example:
|
||||||
|
|
||||||
|
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
||||||
|
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
||||||
|
|
||||||
|
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
||||||
|
|
||||||
|
- In general it looks like this:
|
||||||
|
|
||||||
> ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10)
|
> ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10)
|
||||||
> #### 09/01/15
|
> #### 09/01/15
|
||||||
|
@ -34,16 +40,14 @@ You're almost done!
|
||||||
> - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122)
|
> - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122)
|
||||||
|
|
||||||
|
|
||||||
##Features
|
##Features and the benefits and advantages of this project to others:
|
||||||
|
- Custom date format supported
|
||||||
- **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:
|
- 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)
|
|
||||||
- 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)
|
||||||
|
|
||||||
|
@ -100,22 +104,16 @@ 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.
|
||||||
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
|
|
||||||
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
|
||||||
|
|
||||||
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
|
||||||
|
|
||||||
|
|
||||||
## Projects using this library
|
## Projects using this library
|
||||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||||
|
|
||||||
*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
*If you are using `github_changelog_generator` for generation changelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||||
|
|
||||||
## Am I missed some essential feature?
|
## Am I missed some essential feature?
|
||||||
|
|
||||||
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
**Nothing is impossible!**
|
||||||
|
|
||||||
|
Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
||||||
|
|
||||||
|
@ -131,7 +129,3 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||||
|
|
||||||
|
|
||||||
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user