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
<!-- When adding a new option, please keep the alphabetical order. -->
4
+
5
+
## `changelog_file`
3
6
4
7
- Type: `str`
5
8
- Default: `CHANGELOG.md`
6
9
7
10
Filename of exported changelog
8
11
9
-
###`changelog_format`
12
+
## `changelog_format`
10
13
11
14
- Type: `str`
12
15
- Default: `None`
13
16
14
-
Format used to parse and generate the changelog. If not specified, guessed from [`changelog_file`](#changelog_file).
17
+
Format used to parse and generate the changelog. If not specified, resolved from [`changelog_file`](#changelog_file).
15
18
16
-
###`changelog_incremental`
19
+
## `changelog_incremental`
17
20
18
21
- Type: `bool`
19
22
- Default: `False`
@@ -23,31 +26,30 @@ Update changelog with the missing versions. This is good if you don't want to re
23
26
!!! note
24
27
When doing `cz bump --changelog` this is automatically set to `True`
25
28
26
-
###`changelog_start_rev`
29
+
## `changelog_start_rev`
27
30
28
31
- Type: `str`
29
32
- Default: `None`
30
33
31
34
Start from a given git rev to generate the changelog
32
35
33
-
###`changelog_merge_prerelease`
36
+
## `changelog_merge_prerelease`
34
37
35
38
- Type: `bool`
36
39
- Default: `False`
37
40
38
41
Collect all changes of prerelease versions into the next non-prerelease version when creating the changelog.
39
42
40
-
41
-
### `template`
43
+
## `template`
42
44
43
45
- Type: `str`
44
46
- Default: `None` (provided by plugin)
45
47
46
-
Provide custom changelog jinja template path relative to the current working directory. [Read more][template-customization]
48
+
Provide custom changelog jinja template path relative to the current working directory. See [templatecustomization](../customization.md#customizing-the-changelog-template) for more details.
47
49
48
-
###`extras`
50
+
## `extras`
49
51
50
52
- Type: `dict[str, Any]`
51
53
- Default: `{}`
52
54
53
-
Provide extra variables to the changelog template. [Read more][template-customization]
55
+
Provide extra variables to the changelog template. See [templatecustomization](../customization.md#customizing-the-changelog-template) for more details.
List of prefixes that commitizen ignores when verifying messages.
9
18
10
-
###`message_length_limit`
19
+
## `message_length_limit`
11
20
12
21
Type: `int`
13
22
14
23
Default: `0`
15
24
16
25
Maximum length of the commit message. Setting it to `0` disables the length limit. It can be overridden by the `-l/--message-length-limit` command line argument.
<!-- When adding a new option, please keep the alphabetical order. -->
3
4
4
-
- Type: `bool`
5
-
- Default: `False`
6
-
7
-
When true, breaking changes will be also indicated by an exclamation mark in the commit title (e.g., `feat!: breaking change`).
8
-
When false, breaking changes will be only indicated by `BREAKING CHANGE:` in the footer. [Read more][writing_commits]
9
-
10
-
### `retry_after_failure`
5
+
## `breaking_change_exclamation_in_title`
11
6
12
7
- Type: `bool`
13
8
- Default: `False`
14
9
15
-
Automatically retry failed commit when running `cz commit`. [Read more][retry_after_failure]
10
+
When true, breaking changes will be also indicated by an exclamation mark in the commit title (e.g., `feat!: breaking change`).
16
11
12
+
When false, breaking changes will be only indicated by `BREAKING CHANGE:` in the footer. See [writing commits](../tutorials/writing_commits.md) for more details.
17
13
18
-
###`encoding`
14
+
## `encoding`
19
15
20
16
- Type: `str`
21
17
- Default: `"utf-8"`
22
18
23
19
Sets the character encoding to be used when parsing commit messages. [Read more][encoding]
20
+
21
+
## `retry_after_failure`
22
+
23
+
- Type: `bool`
24
+
- Default: `False`
25
+
26
+
Automatically retry failed commit when running `cz commit`. [Read more][retry_after_failure]
Copy file name to clipboardExpand all lines: docs/config/option.md
+3-22Lines changed: 3 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,37 +19,18 @@ Current version. Example: `"0.1.2"`. Required if you use `version_provider = "co
19
19
- Type: `list`
20
20
- Default: `[]`
21
21
22
-
Style for the prompts (It will merge this value with default style.) [See More (Styling your prompts with your favorite colors)][additional-features]
22
+
Style for the prompts (It will merge this value with default style.) See [Styling your prompts with your favorite colors](https://github.com/tmbo/questionary#additional-features) for more details.
23
23
24
24
### `customize`
25
25
26
26
- Type: `dict`
27
27
- Default: `None`
28
28
29
-
**This is only supported when config through `toml`.** Custom rules for committing and bumping. [Read more][customization]
29
+
**This is only supported when config through `toml`.** Custom rules for committing and bumping. See [customization](../customization.md) for more details.
30
30
31
31
### `use_shortcuts`
32
32
33
33
- Type: `bool`
34
34
- Default: `False`
35
35
36
-
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]
If enabled, Commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. See [shortcut keys](../customization.md#shortcut-keys) for more details.
Copy file name to clipboardExpand all lines: docs/config/version_provider.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,14 @@
1
1
# Version Providers
2
2
3
-
Version providers are the mechanism by which Commitizen reads and writes version information in your project. They abstract away the details of where and how version numbers are stored, allowing Commitizen to work seamlessly with different project types and package management systems.
3
+
Version providers are the mechanism by which Commitizen reads and writes version information in your project.
4
+
5
+
They abstract away the details of where and how version numbers are stored, allowing Commitizen to work seamlessly with different project types and package management systems.
4
6
5
7
## Overview
6
8
7
-
By default, Commitizen uses the `commitizen` provider, which stores the version in your Commitizen configuration file. However, you can configure Commitizen to use any available provider that matches your project's setup. This is particularly useful when you want Commitizen to manage versions in the same location as your package manager (e.g., `package.json` for Node.js projects, `pyproject.toml` for Python projects).
9
+
By default, Commitizen uses the `commitizen` provider, which stores the version in your Commitizen configuration file.
10
+
However, you can configure Commitizen to use any available provider that matches your project's setup.
11
+
This is particularly useful when you want Commitizen to manage versions in the same location as your package manager (e.g., `package.json` for Node.js projects, `pyproject.toml` for Python projects).
0 commit comments