Skip to content

Creation of CHANGELOG.md

Jennifer Marx edited this page Mar 28, 2017 · 10 revisions

Using GitHub Changelog Generator.

Installation

Locally (tested with OSX 10.12 && ruby v2.3.3):

sudo gem install github_changelog_generator

Usage:

github_changelog_generator --future-release <version> -t <github_token>

where <version> is the tag to be used for the next release (for example: v1.2.0) and <github_token> is a new (accept default options) or existing personal access token.

This will create/overwrite CHANGELOG.md in the current directory containing all the closed issues and pull requests on Github as of today. If you are creating a release from a commit that's not current, you may have to edit the changelog file to remove the items created after the release commit date.

NOTE: The Changelog Generator tool is smart in the sense that if a issue is closed in a prior release, but has since been reopened, it will take that into account and edit the prior releases changelog. This make look confusing at first to some!