Skip to content

Commit

Permalink
docs(website): add more git range examples (#655)
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed May 27, 2024
1 parent 076f859 commit d451252
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion website/docs/usage/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 1,7 @@
---
sidebar_position: 3
---

# Examples

To simply create a changelog at your projects git root directory:
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit d451252

Please sign in to comment.