Skip to content

Commit

Permalink
docs(website): add information about --bump with tag prefixes (#695)
Browse files Browse the repository at this point in the history
Signed-off-by: Bukowa <gitbukowa@gmail.com>
  • Loading branch information
bukowa authored Jun 13, 2024
1 parent 8a9f9f4 commit 4cd18c2
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion website/docs/usage/bump-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ To calculate and set the next semantic version (i.e. _bump the version_) for the
git cliff --bump
```

For example, if you have `1.0.0` and committed "feat: xyz", `git-cliff --bump --unreleased` will create a changelog for `1.1.0`.
- Basic:
- For example, if you have `1.0.0` and committed "feat: xyz", `git-cliff --bump --unreleased` will create a changelog for `1.1.0`.

- Tag prefixes:
- Tag prefixes are also supported, for example `testing/v1.0.0-beta.1` can be updated to `testing/v1.0.0-beta.2`

How it works is that for a semantic versioning such as `<MAJOR>.<MINOR>.<PATCH>`:

Expand Down

0 comments on commit 4cd18c2

Please sign in to comment.