will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
54 Commits 16 Branches 72 Tags 1.8 MiB
Ruby 99.7%
Dockerfile 0.3%
5e64e5a226
Go to file
Petr Korolev 5e64e5a226 add copyright to the end
2014-11-06 20:01:19 +02:00
bin make it executable + man fix 2014-11-06 18:59:06 +02:00
lib add copyright to the end 2014-11-06 20:01:19 +02:00
.gitignore named putput file 2014-11-05 18:49:59 +02:00
Gemfile add gemfiles 2014-11-06 15:18:07 +02:00
Gemfile.lock add gemfiles 2014-11-06 15:18:07 +02:00
github_changelog_generator.gemspec add exec 2014-11-06 17:07:13 +02:00
README.md update readme 2014-11-06 19:48:59 +02:00

README.md

Github Changelog Generator

Gem Version

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 [your_project]_changelog.md file with pretty Markdown-formatted changelogs in your current directory.

Params:

github_changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
    -u, --user [USER]                your username on GitHub
    -p, --project [PROJECT]          name of project on GitHub
    -t, --token [TOKEN]              To make more than 50 requests this app 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 last 2 tags
    -f, --date-format [FORMAT]       date format. default is %d/%m/%y

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

  1. Create an issue to discuss about your idea
  2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
  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! :)