Repository files navigation

Changelog generation has never been so easy.

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

You're almost done!

[sudo] gem install github_changelog_generator

It's really simple:

• If yourgit remoteorigin refer to your GitHub repo, then just go to your project folder just run:

    github_changelog_generator

• or from anywhere:

   github_changelog_generator -u github-username -p github-project

As output you will getCHANGELOG.md file withpretty Markdown-formatted changelog.

Typegithub_changelog_generator --help for detailed usage.

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 here: https://github.com/settings/tokens/new    -h, --help                       Displays Help        --[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        --[no-]author                Add author of pull-request in the end. Default is true    -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'    -v, --version                    Print version number

Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token

You can easilygenerate it here.

And:

• Run with key-t [your-16-digit-token]

• Or set environment variableCHANGELOG_GITHUB_TOKEN and specify there your token.

  i.e. add to your~/.bash_profile or~/.zshrc or any other place to load ENV variables stringexport CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'

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'

It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.

• Look atCHANGELOG.md forthis project

• ActionSheetPicker-3.0/CHANGELOG.md was generated by command:

    github_changelog_generator -u skywinder -p ActionSheetPicker-3.0

Wikipage with list of projects

If you are usinggithub_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.

Nothing is impossible! Open anissue and let's make generator better together!

Bug reports, feature requests, patches, well-wishes are always welcome!

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

Github Changelog Generator is released under theMIT License.