You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Allow some prefixes and do not try to match the regex when checking the message. [Read more][allowed_prefixes]
129
119
130
-
Type: `str`
120
+
### `changelog_file`
131
121
132
-
Default: `CHANGELOG.md`
122
+
- Type: `str`
123
+
- Default: `CHANGELOG.md`
133
124
134
125
Filename of exported changelog
135
126
136
127
### `changelog_format`
137
128
138
-
Type: `str`
129
+
- Type: `str`
130
+
- Default: `None`
139
131
140
-
Default: None
141
-
142
-
Format used to parse and generate the changelog, If not specified, guessed from [`changelog_file`](#changelog_file).
132
+
Format used to parse and generate the changelog. If not specified, guessed from [`changelog_file`](#changelog_file).
143
133
144
134
### `changelog_incremental`
145
135
146
-
Type: `bool`
136
+
- Type: `bool`
137
+
- Default: `false`
147
138
148
-
Default: `false`
139
+
Update changelog with the missing versions. This is good if you don't want to replace previous versions in the file.
149
140
150
-
Update changelog with the missing versions. This is good if you don't want to replace previous versions in the file. Note: when doing `cz bump --changelog` this is automatically set to `true`
141
+
!!! note
142
+
When doing `cz bump --changelog` this is automatically set to `true`
151
143
152
144
### `changelog_start_rev`
153
145
154
-
Type: `str`
155
-
156
-
Default: `None`
146
+
- Type: `str`
147
+
- Default: `None`
157
148
158
149
Start from a given git rev to generate the changelog
159
150
160
151
### `changelog_merge_prerelease`
161
152
162
-
Type: `bool`
163
-
164
-
Default: `false`
153
+
- Type: `bool`
154
+
- Default: `false`
165
155
166
156
Collect all changes of prerelease versions into the next non-prerelease version when creating the changelog.
167
157
168
158
### `style`
169
159
170
-
Type: `list`
171
-
172
-
see above
160
+
- Type: `list`
161
+
- Default: `[]`
173
162
174
163
Style for the prompts (It will merge this value with default style.) [See More (Styling your prompts with your favorite colors)][additional-features]
175
164
176
165
### `customize`
177
166
178
-
Type: `dict`
179
-
180
-
Default: `None`
167
+
- Type: `dict`
168
+
- Default: `None`
181
169
182
170
**This is only supported when config through `toml`.** Custom rules for committing and bumping. [Read more][customization]
183
171
184
172
### `use_shortcuts`
185
173
186
-
Type: `bool`
187
-
188
-
Default: `false`
174
+
- Type: `bool`
175
+
- Default: `false`
189
176
190
177
If enabled, Commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. [Read more][shortcuts]
191
178
192
179
### `major_version_zero`
193
180
194
-
Type: `bool`
195
-
196
-
Default: `false`
181
+
- Type: `bool`
182
+
- Default: `false`
197
183
198
-
When true, breaking changes on a `0.x` will remain as a `0.x` version. On `false`, a breaking change will bump a `0.x` version to `1.0`. [Read more][major-version-zero]
184
+
If enabled, breaking changes on a `0.x` will remain as a `0.x` version. Otherwise, a breaking change will bump a `0.x` version to `1.0`. [Read more][major-version-zero]
199
185
200
186
### `prerelease_offset`
201
187
202
-
Type: `int`
203
-
204
-
Default: `0`
188
+
- Type: `int`
189
+
- Default: `0`
205
190
206
191
In some circumstances, a prerelease cannot start with a 0, e.g. in an embedded project individual characters are encoded as bytes. This can be done by specifying an offset from which to start counting. [Read more][prerelease-offset]
207
192
208
193
### `pre_bump_hooks`
209
194
210
-
Type: `list[str]`
211
-
212
-
Default: `[]`
195
+
- Type: `list[str]`
196
+
- Default: `[]`
213
197
214
198
Calls the hook scripts **before** bumping version. [Read more][pre_bump_hooks]
215
199
216
200
### `post_bump_hooks`
217
201
218
-
Type: `list[str]`
219
-
220
-
Default: `[]`
202
+
- Type: `list[str]`
203
+
- Default: `[]`
221
204
222
205
Calls the hook scripts **after** bumping the version. [Read more][post_bump_hooks]
223
206
224
207
### `encoding`
225
208
226
-
Type: `str`
227
-
228
-
Default: `utf-8`
209
+
- Type: `str`
210
+
- Default: `utf-8`
229
211
230
212
Sets the character encoding to be used when parsing commit messages. [Read more][encoding]
231
213
232
214
### `template`
233
215
234
-
Type: `str`
235
-
236
-
Default: `None` (provided by plugin)
216
+
- Type: `str`
217
+
- Default: `None` (provided by plugin)
237
218
238
219
Provide custom changelog jinja template path relative to the current working directory. [Read more][template-customization]
239
220
240
221
### `extras`
241
222
242
-
Type: `dict[str, Any]`
243
-
244
-
Default: `{}`
223
+
- Type: `dict[str, Any]`
224
+
- Default: `{}`
245
225
246
226
Provide extra variables to the changelog template. [Read more][template-customization]
247
227
@@ -255,7 +235,7 @@ You can also create a `.cz.toml` or `cz.toml` file at the root of your project f
255
235
256
236
Example configuration:
257
237
258
-
```toml
238
+
```toml title=".cz.toml"
259
239
[tool.commitizen]
260
240
name = "cz_conventional_commits"
261
241
version = "0.1.0"
@@ -282,7 +262,7 @@ style = [
282
262
283
263
Commitizen has support for JSON configuration. Recommended for `NodeJS` projects.
284
264
285
-
```json
265
+
```json title=".cz.json"
286
266
{
287
267
"commitizen": {
288
268
"name": "cz_conventional_commits",
@@ -308,7 +288,7 @@ Commitizen has support for JSON configuration. Recommended for `NodeJS` projects
308
288
309
289
YAML configuration is supported by Commitizen. Recommended for `Go`, `ansible`, or even `helm` charts projects.
310
290
311
-
```yaml
291
+
```yaml title=".cz.yaml"
312
292
commitizen:
313
293
name: cz_conventional_commits
314
294
version: 0.1.0
@@ -371,7 +351,7 @@ version_provider = "pep621"
371
351
372
352
You can add your own version provider by extending `VersionProvider` and exposing it on the `commitizen.provider` entrypoint.
373
353
374
-
Here is a quick example of a `my-provider` provider reading and writing version in a `VERSION` file.
354
+
Here is a quick example of a provider reading and writing version in a `VERSION` file.
0 commit comments