From e8fa7a25b4648cc04800eeb8d81ec2efd1e21f02 Mon Sep 17 00:00:00 2001 From: grahamhar Date: Sat, 20 Apr 2024 11:23:52 +0100 Subject: [PATCH] docs(bump): Document the use of tag_format variables with curly brackets --- docs/commands/bump.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/commands/bump.md b/docs/commands/bump.md index efb5b0881..ed0019324 100644 --- a/docs/commands/bump.md +++ b/docs/commands/bump.md @@ -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 | ---