Skip to content

Commit 76f7fcb

Browse files
grahamharwoile
authored andcommitted
docs(bump): Document the use of tag_format variables with curly brackets
1 parent ca3865f commit 76f7fcb

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
@@ -414,18 +414,24 @@ In your `pyproject.toml` or `.cz.toml`
414414
tag_format = "v$major.$minor.$patch$prerelease"
415415
```
416416

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

419419
Supported variables:
420420

421-
| Variable | Description |
422-
| ------------- | ------------------------------------------- |
423-
| `$version` | full generated version |
424-
| `$major` | MAJOR increment |
425-
| `$minor` | MINOR increment |
426-
| `$patch` | PATCH increment |
427-
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
428-
| `$devrelease` | Development release |
421+
| Variable | Description |
422+
|-----------------|---------------------------------------------|
423+
| `$version` | full generated version |
424+
| `$major` | MAJOR increment |
425+
| `$minor` | MINOR increment |
426+
| `$patch` | PATCH increment |
427+
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
428+
| `$devrelease` | Development release |
429+
| `${version}` | full generated version |
430+
| `${major}` | MAJOR increment |
431+
| `${minor}` | MINOR increment |
432+
| `${patch}` | PATCH increment |
433+
| `${prerelease}` | Prerelease (alpha, beta, release candidate) |
434+
| `${devrelease}` | Development release |
429435

430436
---
431437

0 commit comments

Comments
 (0)