Browse Source

git-cliff: add page (#15611)

* git-cliff: add page

* Apply suggestions from code review

Co-authored-by: Wiktor Perskawiec <git@spageektti.cc>

---------

Co-authored-by: Wiktor Perskawiec <git@spageektti.cc>
Lena 1 month ago
parent
commit
7f04c6819b
1 changed files with 24 additions and 0 deletions
  1. 24 0
      pages/common/git-cliff.md

+ 24 - 0
pages/common/git-cliff.md

@@ -0,0 +1,24 @@
+# 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}}`