Skip to content

Commit c19cd1d

Browse files
committed
docs(bump): Document the use of tag_format variables with curly brackets
1 parent 8d08840 commit c19cd1d

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

Diff for: docs/bump.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -433,18 +433,24 @@ In your `pyproject.toml` or `.cz.toml`
433433
tag_format = "v$major.$minor.$patch$prerelease"
434434
```
435435
436-
The variables must be preceded by a `$` sign. Default is `$version`.
436+
The variables must be preceded by a `$` sign and optionally can be wrapped in `{}` . Default is `$version`.
437437
438438
Supported variables:
439439
440-
| Variable | Description |
441-
| ------------- | ------------------------------------------- |
442-
| `$version` | full generated version |
443-
| `$major` | MAJOR increment |
444-
| `$minor` | MINOR increment |
445-
| `$patch` | PATCH increment |
446-
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
447-
| `$devrelease` | Development release |
440+
| Variable | Description |
441+
|-----------------|---------------------------------------------|
442+
| `$version` | full generated version |
443+
| `$major` | MAJOR increment |
444+
| `$minor` | MINOR increment |
445+
| `$patch` | PATCH increment |
446+
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
447+
| `$devrelease` | Development release |
448+
| `${version}` | full generated version |
449+
| `${major}` | MAJOR increment |
450+
| `${minor}` | MINOR increment |
451+
| `${patch}` | PATCH increment |
452+
| `${prerelease}` | Prerelease (alpha, beta, release candidate) |
453+
| `${devrelease}` | Development release |
448454
449455
---
450456

0 commit comments

Comments
 (0)