@@ -31,7 +31,7 @@ cz bump --version-scheme semver
3131```
3232
33332 . Configuration file:
34- ``` toml
34+ ``` toml title="pyproject.toml"
3535[tool .commitizen ]
3636version_scheme = " semver"
3737```
@@ -113,7 +113,7 @@ Note that as per [semantic versioning spec](https://semver.org/#spec-item-9)
113113For example, the following versions (using the [ PEP 440] ( https://peps.python.org/pep-0440/ ) scheme) are ordered
114114by their precedence and showcase how a release might flow through a development cycle:
115115
116- - ` 1.0.0 ` is the current published version
116+ - ` 1.0.0 ` is the currently published version
117117- ` 1.0.1a0 ` after committing a ` fix: ` for pre-release
118118- ` 1.1.0a1 ` after committing an additional ` feat: ` for pre-release
119119- ` 1.1.0b0 ` after bumping a beta release
@@ -151,9 +151,9 @@ configuration are consistent before bumping version.
151151cz bump --check-consistency
152152```
153153
154- For example, if we have ` pyproject.toml `
154+ For example, if we have
155155
156- ``` toml
156+ ``` toml title="pyproject.toml"
157157[tool .commitizen ]
158158version = " 1.21.0"
159159version_files = [
@@ -162,15 +162,11 @@ version_files = [
162162]
163163```
164164
165- ` src/__version__.py ` ,
166-
167- ``` python
165+ ``` python title="src/__version__.py"
168166__version__ = " 1.21.0"
169167```
170168
171- and ` setup.py ` .
172-
173- ``` python
169+ ``` python title="setup.py"
174170from setuptools import setup
175171
176172setup(... , version = " 1.0.5" , ... )
@@ -193,7 +189,7 @@ cz bump --local-version
193189
194190For example, if we have ` pyproject.toml `
195191
196- ``` toml
192+ ``` toml title="pyproject.toml"
197193[tool .commitizen ]
198194version = " 5.3.5+0.1.0"
199195```
@@ -454,7 +450,7 @@ In your `pyproject.toml` or `.cz.toml`
454450tag_format = " v$major.$minor.$patch$prerelease"
455451```
456452
457- The variables must be preceded by a ` $ ` sign and optionally can be wrapped in ` {} ` . Default is ` $version ` .
453+ The variables must be preceded by a ` $ ` sign and optionally can be wrapped in ` {} ` . The default is ` $version ` .
458454
459455Supported variables:
460456
@@ -483,7 +479,7 @@ Some examples
483479
484480` pyproject.toml ` , ` .cz.toml ` or ` cz.toml `
485481
486- ``` toml
482+ ``` toml title="pyproject.toml"
487483[tool .commitizen ]
488484version_files = [
489485 " src/__version__.py" ,
@@ -496,8 +492,7 @@ This means that it will find a file `setup.py` and will only make a change
496492in a line containing the ` version ` substring.
497493
498494!!! note
499- Files can be specified using relative (to the execution) paths, absolute paths
500- or glob patterns.
495+ Files can be specified using relative (to the execution) paths, absolute paths, or glob patterns.
501496
502497---
503498
@@ -516,7 +511,7 @@ Some examples
516511
517512` pyproject.toml ` , ` .cz.toml ` or ` cz.toml `
518513
519- ``` toml
514+ ``` toml title="pyproject.toml"
520515[tool .commitizen ]
521516bump_message = " release $current_version → $new_version [skip-ci]"
522517```
@@ -529,7 +524,7 @@ When set to `true` the changelog is always updated incrementally when running `c
529524
530525Defaults to: ` false `
531526
532- ``` toml
527+ ``` toml title="pyproject.toml"
533528[tool .commitizen ]
534529update_changelog_on_bump = true
535530```
@@ -540,7 +535,7 @@ update_changelog_on_bump = true
540535
541536When set to ` true ` , Commitizen will create annotated tags.
542537
543- ``` toml
538+ ``` toml title="pyproject.toml"
544539[tool .commitizen ]
545540annotated_tag = true
546541```
@@ -551,7 +546,7 @@ annotated_tag = true
551546
552547When set to ` true ` , Commitizen will create gpg signed tags.
553548
554- ``` toml
549+ ``` toml title="pyproject.toml"
555550[tool .commitizen ]
556551gpg_sign = true
557552```
@@ -565,7 +560,7 @@ Useful during the initial development stage of your project.
565560
566561Defaults to: ` false `
567562
568- ``` toml
563+ ``` toml title="pyproject.toml"
569564[tool .commitizen ]
570565major_version_zero = true
571566```
@@ -591,7 +586,7 @@ execution of the script, some environment variables are available:
591586| ` CZ_PRE_INCREMENT ` | Whether this is a ` MAJOR ` , ` MINOR ` or ` PATH ` release |
592587| ` CZ_PRE_CHANGELOG_FILE_NAME ` | Path to the changelog file, if available |
593588
594- ``` toml
589+ ``` toml title="pyproject.toml"
595590[tool .commitizen ]
596591pre_bump_hooks = [
597592 " scripts/generate_documentation.sh"
@@ -618,7 +613,7 @@ release. During execution of the script, some environment variables are availabl
618613| ` CZ_POST_INCREMENT ` | Whether this was a ` MAJOR ` , ` MINOR ` or ` PATH ` release |
619614| ` CZ_POST_CHANGELOG_FILE_NAME ` | Path to the changelog file, if available |
620615
621- ``` toml
616+ ``` toml title="pyproject.toml"
622617[tool .commitizen ]
623618post_bump_hooks = [
624619 " scripts/slack_notification.sh"
@@ -631,7 +626,7 @@ Offset with which to start counting prereleases.
631626
632627Defaults to: ` 0 `
633628
634- ``` toml
629+ ``` toml title="pyproject.toml"
635630[tool .commitizen ]
636631prerelease_offset = 1
637632```
@@ -651,7 +646,7 @@ Options: `pep440`, `semver`, `semver2`
651646
652647Defaults to: ` pep440 `
653648
654- ``` toml
649+ ``` toml title="pyproject.toml"
655650[tool .commitizen ]
656651version_scheme = " semver"
657652```
0 commit comments