Skip to content

Commit

Permalink
docs(bump): Document the use of tag_format variables with curly brackets
Browse files Browse the repository at this point in the history
  • Loading branch information
@grahamhar @woile
grahamhar authored and woile committed Sep 16, 2024
1 parent 97eb90c commit e8fa7a2
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions docs/commands/bump.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -414,18 +414,24 @@ In your `pyproject.toml` or `.cz.toml`
tag_format = "v$major.$minor.$patch$prerelease"
```

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

Supported variables:

| Variable | Description |
| ------------- | ------------------------------------------- |
| `$version` | full generated version |
| `$major` | MAJOR increment |
| `$minor` | MINOR increment |
| `$patch` | PATCH increment |
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
| `$devrelease` | Development release |
| Variable | Description |
|-----------------|---------------------------------------------|
| `$version` | full generated version |
| `$major` | MAJOR increment |
| `$minor` | MINOR increment |
| `$patch` | PATCH increment |
| `$prerelease` | Prerelease (alpha, beta, release candidate) |
| `$devrelease` | Development release |
| `${version}` | full generated version |
| `${major}` | MAJOR increment |
| `${minor}` | MINOR increment |
| `${patch}` | PATCH increment |
| `${prerelease}` | Prerelease (alpha, beta, release candidate) |
| `${devrelease}` | Development release |

---

Expand Down

0 comments on commit e8fa7a2

Please sign in to comment.