An opinionated GitHub Cli extension for creating changelogs that adhere to the keep a changelog specification.
gh-changelog is the tool for you if:
- You want to closely follow the keep a changelog specification
- You are using tags to mark releases
- You are following a pull-request workflow
Before you start make sure that:
- GitHub Cli is installed and authenticated
- You are inside a git repository
- The repository contains commits and has been pushed to GitHub
gh extension install chelnak/gh-changeloggh extension upgrade chelnak/gh-changeloggh changelog newgh changelog new --next-version v1.2.0gh changelog showgh changelog configOr to print out JSON instead of YAML:
gh changelog config -o jsonConfiguration for gh changelog can be found at ~/.config/gh-changelog/config.yaml.
However some sensible defaults are provided to help you get off to a flying start.
# Labels added here will be ommitted from the changelog
excluded_labels:
- maintenance
# This is the filename of the generated changelog
file_name: CHANGELOG.md
# This is where labels are mapped to the sections in a changelog entry
# The possible sections are restricted to: Added, Changed, Deprecated,
# Removed, Fixed, Security.
sections:
changed:
- backwards-incompatible
added:
- fixed
- enhancement
fixed:
- bug
- bugfix
- documentation
# When set to true, unlabelled entries will not be included in the changelog.
# By default they will be grouped in a section named "Other".
skip_entries_without_label: false
# Adds an unreleased section to the changelog. This will contain any qualifying entries
# that have been added since the last tag.
# Note: The unreleased section is not created when the --next-version flag is used.
show_unreleased: true
# If set to false, the tool will not check remotely for updates
check_for_updates: trueYou can also override any setting using environment variables. When configured from the environment,
properties are prefixed with CHANGELOG.
For example, overriding check_for_updates might look
something like this:
export CHANGELOG_CHECK_FOR_UPDATES=false
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent