From 7f04c6819bfa66d4ab05b285a377ee0c3a89faba Mon Sep 17 00:00:00 2001 From: Lena <126529524+acuteenvy@users.noreply.github.com> Date: Fri, 31 Jan 2025 23:16:07 +0100 Subject: [PATCH] git-cliff: add page (#15611) * git-cliff: add page * Apply suggestions from code review Co-authored-by: Wiktor Perskawiec --------- Co-authored-by: Wiktor Perskawiec --- pages/common/git-cliff.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pages/common/git-cliff.md diff --git a/pages/common/git-cliff.md b/pages/common/git-cliff.md new file mode 100644 index 0000000000..cc090dfdeb --- /dev/null +++ b/pages/common/git-cliff.md @@ -0,0 +1,24 @@ +# git cliff + +> A highly customizable changelog generator. +> More information: . + +- 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}}`