Skip to content

Commit

Permalink
git-cliff: add page (#15611)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
acuteenvy and spageektti authored Jan 31, 2025
1 parent c0e5ac9 commit 7f04c68
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions pages/common/git-cliff.md
Original file line number Diff line number Diff line change
@@ -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}}`

0 comments on commit 7f04c68

Please sign in to comment.