Commit 76f7fcb

grahamharwoile

authored and

committed

docs(bump): Document the use of tag_format variables with curly brackets

1 parent ca3865f commit 76f7fcbCopy full SHA for 76f7fcb

File tree

+15

-9

lines changed

+15

-9

lines changed

Lines changed: 15 additions & 9 deletions

Original file line number	Diff line number	Diff line change
@@ -414,18 +414,24 @@ In your `pyproject.toml` or `.cz.toml`
`414`	`414`	`tag_format = "v$major.$minor.$patch$prerelease"`
`415`	`415`	```
`416`	`416`
`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`.
`418`	`418`
`419`	`419`	`Supported variables:`
`420`	`420`
`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 \|
`429`	`435`
`430`	`436`	`---`
`431`	`437`

Comments

(0)