github-changelog-generator/README.md

58 lines
3.0 KiB
Markdown
Raw Normal View History

2014-11-06 13:53:01 +00:00
Github Changelog Generator
2014-11-06 13:39:10 +00:00
==================
2014-11-06 17:30:51 +00:00
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
2014-11-06 13:47:56 +00:00
This script automatically generate change-log from your tags and merged pull-requests.
2014-11-06 13:39:10 +00:00
2014-11-06 17:14:35 +00:00
## Installation:
gem install github_changelog_generator
2014-11-06 17:14:35 +00:00
## Usage
2014-11-06 13:47:56 +00:00
2014-11-06 17:14:35 +00:00
### Example usage:
github_changelog_generator -u github-username -p github-project
2014-11-06 17:14:35 +00:00
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
2014-11-06 17:14:35 +00:00
2014-11-06 17:45:56 +00:00
### Params:
See `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)
-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
2014-11-06 17:45:56 +00:00
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-l, --last-changes Generate log between only last 2 tags
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
-o, --output [FORMAT] Output file. Default is CHANGELOG.md
2014-11-06 17:25:58 +00:00
2014-11-06 17:45:56 +00:00
## Real examples:
### [This changelog](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by
`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
2014-11-06 17:14:35 +00:00
## FAQ
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)**.
2014-11-06 13:47:56 +00:00
2014-11-06 17:14:35 +00:00
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)
2014-11-06 14:35:53 +00:00
2014-11-06 17:14:35 +00:00
Then you have to generate this token or wait for 1 hour
2014-11-06 14:35:53 +00:00
## License
2014-11-06 17:33:44 +00:00
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
## Contributing
1. Create an issue to discuss about your idea
2014-11-06 17:48:59 +00:00
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
2014-11-06 17:33:44 +00:00
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
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!**
*Improvements more than welcome - they are kindly requested! :)*