Github Changelog Generator

This script automatically generate change-log from your tags and merged pull-requests.

Installation:

gem install github_changelog_generator

Usage

Example usage:

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.

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
    -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

Real examples:

This changelog was generated by

github_changelog_generator -u skywinder -p ActionSheetPicker-3.0: ActionSheetPicker-3.0/CHANGELOG.md

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.

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 89678f7d7f: 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)

Then you have to generate this token or wait for 1 hour

License

Github Changelog Generator is released under the MIT License.

Contributing

Create an issue to discuss about your idea
[Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
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! :)

3.0 KiB Raw Blame History