Skip to content

Commit d87cd1a

Browse files
committed
docs(bump): added information about .cz deprecation
1 parent 9b3ff72 commit d87cd1a

File tree

1 file changed

+36
-24
lines changed

1 file changed

+36
-24
lines changed

docs/bump.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,19 @@ cz bump --tag_format="v$version"
9292
cz bump --tag_format="v$minor.$major.$path$prerelease"
9393
```
9494

95-
In your `pyproject.toml`
95+
In your `pyproject.toml` or `.cz.toml`
9696

97-
[tool.commitizen]
98-
tag_format = "v$minor.$major.$path$prerelease"
97+
```toml
98+
[tool.commitizen]
99+
tag_format = "v$minor.$major.$path$prerelease"
100+
```
99101

100-
Or in your `.cz`
102+
Or in your `.cz` (TO BE DEPRECATED)
101103

102-
[commitizen]
103-
tag_format = v$minor.$major.$path$prerelease
104+
```
105+
[commitizen]
106+
tag_format = v$minor.$major.$path$prerelease
107+
```
104108

105109
The variables must be preceded by a `$` sign.
106110

@@ -126,21 +130,25 @@ regarding if the file is present or not in `files`.
126130

127131
Some examples
128132

129-
`pyproject.toml`
133+
`pyproject.toml` or `.cz.toml`
130134

131-
[tool.commitizen]
132-
files = [
133-
"src/__version__.py",
134-
"setup.py:version"
135-
]
135+
```toml
136+
[tool.commitizen]
137+
files = [
138+
"src/__version__.py",
139+
"setup.py:version"
140+
]
141+
```
136142

137-
`.cz`
143+
`.cz` (TO BE DEPRECATED)
138144

139-
[commitizen]
140-
files = [
141-
"src/__version__.py",
142-
"setup.py:version"
143-
]
145+
```
146+
[commitizen]
147+
files = [
148+
"src/__version__.py",
149+
"setup.py:version"
150+
]
151+
```
144152

145153
In the example above, we can see the reference `"setup.py:version"`.
146154
This means that it will find a file `setup.py` and will only make a change
@@ -161,15 +169,19 @@ defaults to: `bump: version $current_version → $new_version`
161169

162170
Some examples
163171

164-
`pyproject.toml`
172+
`pyproject.toml` or `.cz.toml`
165173

166-
[tool.commitizen]
167-
bump_message = "release $current_version → $new_version [skip-ci]"
174+
```toml
175+
[tool.commitizen]
176+
bump_message = "release $current_version → $new_version [skip-ci]"
177+
```
168178

169-
`.cz`
179+
`.cz` (TO BE DEPRECATED)
170180

171-
[commitizen]
172-
bump_message = release $current_version → $new_version [skip-ci]
181+
```
182+
[commitizen]
183+
bump_message = release $current_version → $new_version [skip-ci]
184+
```
173185

174186
## Custom bump
175187

0 commit comments

Comments
 (0)