|
3 | 3 | ## Settings
|
4 | 4 |
|
5 | 5 | | Variable | Type | Default | Description |
|
6 |
| -| -------------------------- | ------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 6 | +|----------------------------|--------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
7 | 7 | | `name` | `str` | `"cz_conventional_commits"` | Name of the committing rules to use |
|
8 | 8 | | `version` | `str` | `None` | Current version. Example: "0.1.2" |
|
9 | 9 | | `version_files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more][version_files] |
|
|
21 | 21 | | `use_shortcuts` | `bool` | `false` | 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 more][shortcuts] |
|
22 | 22 | | `major_version_zero` | `bool` | `false` | 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`. [major-version-zero] |
|
23 | 23 | | `prerelease_offset` | `int` | `0` | In special cases it may be necessary that a prerelease cannot start with a 0, e.g. in an embedded project the individual characters are encoded in bytes. This can be done by specifying an offset from which to start counting. [prerelease-offset] |
|
| 24 | +| `version_type` | `str` | `pep440` | Select a version type from the following options [`pep440`, `semver`]. Useful for non python projects. [See more][version_type] | |
24 | 25 |
|
25 | 26 | ## pyproject.toml or .cz.toml
|
26 | 27 |
|
@@ -118,6 +119,7 @@ commitizen:
|
118 | 119 | [major-version-zero]: bump.md#-major-version-zero
|
119 | 120 | [prerelease-offset]: bump.md#-prerelease_offset
|
120 | 121 | [allow_abort]: check.md#allow-abort
|
| 122 | +[version_type]: bump.md#version_type |
121 | 123 | [additional-features]: https://github.com/tmbo/questionary#additional-features
|
122 | 124 | [customization]: customization.md
|
123 | 125 | [shortcuts]: customization.md#shortcut-keys
|
|
0 commit comments