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 2014-11-11 10:57:53 +02:00
parent bc3af7fa93
commit a458a1e378
1 changed files with 35 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -11,33 +11,39 @@ This script automatically generate change-log from your tags and merged pull-req
[sudo] gem install github_changelog_generator
## Usage
**It's really simple**:
- `cd` to your Project folder with configured git and just type:
github_changelog_generator
- from anywhere:
github_changelog_generator -u github-username -p github-project
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
### Params:
See `github_changelog_generator --help` for detailed usage.
## Params:
Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator --user username --project project_name [options]
-u, --user [USER] Username of the owner of target GitHub repo (required)
-p, --project [PROJECT] Name of project on GitHub (required)
Usage: changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo
-p, --project [PROJECT] Name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-v, --[no-]verbose Run verbosely. Default is true
--[no-]issues Include closed issues to changelog. Default is true
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
--[no-]pull-requests Include pull-requests to changelog. Default is true
-l, --last-changes Generate log between last 2 tags only
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
-o, --output [NAME] Output file. Default is CHANGELOG.md
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'a
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
## Examples:
Look at changelog in this project!
### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
Was generated by command:
- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- This changelog: [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
@ -46,13 +52,15 @@ Was generated by command:
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
So, if you got error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden)
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
It's time to generate this token or wait for 1 hour before GitHub reset counter for your IP.
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## License
## Am I missed some essential feature?
Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's get this generator better together!
**Bug reports, feature requests, patches, well-wishes are always welcome!**
## Contributing
@ -63,6 +71,6 @@ Github the Generator is released under the [MIT License](http://www.opensource.o
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!**
## License
*Improvements more than welcome - they are kindly requested! :)*
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).