Update the Changelog

Owned by Aziz OUATTARA
Last updated: Feb 16, 2017
1 min read

To update the changelog, use the Github Changelog Generator tool.

 gem install github_changelog_generator

Usage

GitHub token

Your tokens are available on your github settings

Generate a token here - you only need "repo" scope for private repositories

GitHub only allows only 50 unauthenticated requests per hour. Therefore, it's recommended to run this script with authentication by using a token.

Here's how:

  • Generate a token here - you only need "repo" scope for private repositories
  • Either:
    • Run the script with --token <your-40-digit-token>; OR
    • Set the CHANGELOG_GITHUB_TOKEN environment variable to your 40 digit token

You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., ~/.bash_profile or ~/.zshrc)

export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"

So, if you got an 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 an hour for GitHub to reset your unauthenticated request limit.)

Update the changelog

github_changelog_generator --no-unreleased