Skip to content

Commit f620877

Browse files
committed
docs(bump): add version_type info to config.md
Signed-off-by: apkawa <apkawa@gmail.com>
1 parent e97f572 commit f620877

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Settings
44

55
| Variable | Type | Default | Description |
6-
| -------------------------- | ------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6+
|----------------------------|--------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77
| `name` | `str` | `"cz_conventional_commits"` | Name of the committing rules to use |
88
| `version` | `str` | `None` | Current version. Example: "0.1.2" |
99
| `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,6 +21,7 @@
2121
| `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] |
2222
| `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] |
2323
| `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] |
2425

2526
## pyproject.toml or .cz.toml
2627

@@ -118,6 +119,7 @@ commitizen:
118119
[major-version-zero]: bump.md#-major-version-zero
119120
[prerelease-offset]: bump.md#-prerelease_offset
120121
[allow_abort]: check.md#allow-abort
122+
[version_type]: bump.md#version_type
121123
[additional-features]: https://github.com/tmbo/questionary#additional-features
122124
[customization]: customization.md
123125
[shortcuts]: customization.md#shortcut-keys

0 commit comments

Comments
 (0)