uphold/github-changelog-generator

Name: github-changelog-generator

Owner: Uphold

Description: Generate changelog files from the project's GitHub PRs

Created: 2016-11-24 14:32:40.0

Updated: 2018-04-06 17:53:11.0

Pushed: 2018-04-06 17:53:09.0

Homepage:

Size: 61

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

github-changelog-generator

Generate changelog files from the project's GitHub PRs

Usage

Generate a new GitHub Personal Access Token and save it to your .zshrc.local, .bashrc.local or similar:

rt GITHUB_TOKEN=<your_github_personal_access_token>

To see a list of available options, run the following command:

thub-changelog-generator --help

age: github-changelog-generator [options]

n GitHub changelog generator.

tions:

-h, --help                       output usage information
-o, --owner <name>               [required] owner of the repository
-r, --repo <name>                [required] name of the repository
-b, --base-branch <name>         [optional] specify the base branch name - master by default
-f, --future-release <version>   [optional] specify the next release version
-t, --future-release-tag <name>  [optional] specify the next release tag name if it is different from the release version

To generate a changelog for your GitHub project, use the following command:

thub-changelog-generator --owner=<repo_owner> --repo=<repo_name> --base-branch=<base> --future-release=<release_name> --future-release-tag=<release_tag_name> > <your_changelog_file>

The --base-branch option is optional. It allows you to filter the PRs by base branch and uses master by default.

Example:

thub-changelog-generator --owner=uphold --repo=github-changelog-generator --base-branch=production > CHANGELOG.md

The --future-release and --future-release-tag options are optional. If you just want to build a new changelog without a new release, you can skip those options, and github-changelog-generator will create a changelog for existing releases only. Also, if your future release tag name is the same as your future release version number, then you can skip --future-release-tag.

Example:

thub-changelog-generator --owner=uphold --repo=github-changelog-generator --future-release=1.2.3 --future-release-tag=v1.2.3 > CHANGELOG.md

Release

version [<newversion> | major | minor | patch] -m "Release %s"