orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-11-29 15:42:15 +03:00
Code Issues Projects Releases Wiki Activity

docs(website): add more git range examples (#655)

Browse Source
This commit is contained in:
Orhun Parmaksız 2024-05-27 22:02:00 +03:00
parent 076f859153
commit d4512521fb
No known key found for this signature in database
GPG Key ID: F83424824B3E4B90
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/docs/usage/examples.md
View File

@ -1,6 +1,7 @@
---
sidebar_position: 3
---
# Examples
To simply create a changelog at your projects git root directory:
@ -32,11 +33,16 @@ git cliff --current
# generate changelog for unreleased commits
git cliff --unreleased
git cliff --unreleased --tag 1.0.0
```
# generate changelog for a specific commit range
Generate a changelog for a specific commit range (based on [git ranges](https://git-scm.com/docs/git-range-diff)):
```bash
git cliff 4c7b043..a440c6e
git cliff 4c7b043..HEAD
git cliff HEAD~2..
git cliff v2.2.1..
git cliff v0.1.0..HEAD
```
Sort the commits inside sections: