Skip to content

Commit 7f04c68

Browse files
git-cliff: add page (#15611)
* git-cliff: add page * Apply suggestions from code review Co-authored-by: Wiktor Perskawiec <[email protected]> --------- Co-authored-by: Wiktor Perskawiec <[email protected]>
1 parent c0e5ac9 commit 7f04c68

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

pages/common/git-cliff.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# git cliff
2+
3+
> A highly customizable changelog generator.
4+
> More information: <https://git-cliff.org/docs/usage/args>.
5+
6+
- Generate a changelog from all commits in a Git repository and save it to `CHANGELOG.md`:
7+
8+
`git cliff > {{CHANGELOG.md}}`
9+
10+
- Generate a changelog from commits starting from the latest tag and print it to `stdout`:
11+
12+
`git cliff {{-l|--latest}}`
13+
14+
- Generate a changelog from commits that belong to the current tag (use `git checkout` on a tag before this):
15+
16+
`git cliff --current`
17+
18+
- Generate a changelog from commits that do not belong to a tag:
19+
20+
`git cliff {{-u|--unreleased}}`
21+
22+
- Write the default config file to `cliff.toml` in the current directory:
23+
24+
`git cliff {{-i|--init}}`

0 commit comments

Comments
 (0)