Skip to content

Commit 9bdeba2

Browse files
committed
docs(bump): Document the use of tag_format variables with curly brackets
1 parent fc69622 commit 9bdeba2

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

Diff for: docs/commands/bump.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -381,18 +381,24 @@ In your `pyproject.toml` or `.cz.toml`
381381
tag_format = "v$major.$minor.$patch$prerelease"
382382
```
383383

384-
The variables must be preceded by a `$` sign. Default is `$version`.
384+
The variables must be preceded by a `$` sign and optionally can be wrapped in `{}` . Default is `$version`.
385385

386386
Supported variables:
387387

388-
| Variable | Description |
389-
| ------------- | ------------------------------------------- |
390-
| `$version` | full generated version |
391-
| `$major` | MAJOR increment |
392-
| `$minor` | MINOR increment |
393-
| `$patch` | PATCH increment |
394-
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
395-
| `$devrelease` | Development release |
388+
| Variable | Description |
389+
|-----------------|---------------------------------------------|
390+
| `$version` | full generated version |
391+
| `$major` | MAJOR increment |
392+
| `$minor` | MINOR increment |
393+
| `$patch` | PATCH increment |
394+
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
395+
| `$devrelease` | Development release |
396+
| `${version}` | full generated version |
397+
| `${major}` | MAJOR increment |
398+
| `${minor}` | MINOR increment |
399+
| `${patch}` | PATCH increment |
400+
| `${prerelease}` | Prerelease (alpha, beta, release candidate) |
401+
| `${devrelease}` | Development release |
396402

397403
---
398404

0 commit comments

Comments
 (0)