HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

git cliff — A highly customizable changelog generator. More information: <https://git-cliff.org/docs/usage/args/

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandcustomizablegeneratorchangeloghighlyclimoregit cliff

Problem

How to use the git cliff command: A highly customizable changelog generator. More information: <https://git-cliff.org/docs/usage/args/>.

Solution

git cliff — A highly customizable changelog generator. More information: <https://git-cliff.org/docs/usage/args/>.

Generate a changelog from all commits in a Git repository and save it to CHANGELOG.md:
git cliff > {{CHANGELOG.md}}


Generate a changelog from commits starting from the latest tag and print it to stdout:
git cliff {{[-l|--latest]}}


Generate a changelog from commits that belong to the current tag (use git checkout on a tag before this):
git cliff --current


Generate a changelog from commits that do not belong to a tag:
git cliff {{[-u|--unreleased]}}


Write the default config file to cliff.toml in the current directory:
git cliff {{[-i|--init]}}

Code Snippets

Generate a changelog from all commits in a Git repository and save it to `CHANGELOG.md`

git cliff > {{CHANGELOG.md}}

Generate a changelog from commits starting from the latest tag and print it to `stdout`

git cliff {{[-l|--latest]}}

Generate a changelog from commits that belong to the current tag (use `git checkout` on a tag before this)

git cliff --current

Generate a changelog from commits that do not belong to a tag

git cliff {{[-u|--unreleased]}}

Write the default config file to `cliff.toml` in the current directory

git cliff {{[-i|--init]}}

Context

tldr-pages: common/git cliff

Revisions (0)

No revisions yet.