Skip to content

Instantly share code, notes, and snippets.

@falcucci

falcucci/how-to-changelog.md

Last active July 3, 2020 02:20
Show Gist options
  • Save falcucci/a6ee4d5a274ba2bb9f2b134b46792c4a to your computer and use it in GitHub Desktop.
Save falcucci/a6ee4d5a274ba2bb9f2b134b46792c4a to your computer and use it in GitHub Desktop.
Download ZIP
Step by step instructions to generate your changelog automatically.
Raw
how-to-changelog.md

How to automate your changelog?

First of all, it requires Ruby v2.4.2+ to run.

Said that, install the follow dependencies:

github_changelog_generator

$ [sudo] gem install github_changelog_generator

You could learn more about it here.

Ok, now we are ready to generate your changelog based on tags and github issues!

GitHub only allows 50 unauthenticated requests per hour.

Knowing that we have to generate a token, cuz our repos are private as well.

Generating a changelog.md by the following command...

(put your repository after -p parameter)

$ github_changelog_generator -u luizalabs -p luizalabs-financial-platform-foggy --enhancement-label ":rocket: **New Feature**" --bugs-label ":bug: **Bug Fix**" --no-pull-requests --enhancement-labels 'enhancement,Enhancement,features,Features,feature' --exclude-labels 'duplicate,question,invalid,wontfix,ignore,changelog ignore' --base CHANGELOG.md --token
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment