Last Updated: February 25, 2016
·
523
· skywinder

Generate your CHANGELOG.MD with GitHub Issues

githubchangeloggenerator - generate change log file based on tags, issues and merged pull requests (and split them to separate lists according labels) from GitHub Issue Tracker.

Intall:

gem install github_changelog_generator

Usage

It's really simple:

  • If your git remote origin refer to your GitHub repo, then just go to your project folder and run:

    github_changelog_generator

In general CHANGELOG.md looks like this:

1.2.5 (2015-01-15)

Full Changelog

Implemented enhancements:

  • Use milestone to specify in which version bug was fixed #22

Fixed bugs:

  • Error when trying to generate log for repo without tags #32

Merged pull requests:

  • PrettyPrint class is included using lowercase 'pp' #43 (schwing)

  • support enterprise github via command line options #42 (glenlovett)