@@ -54,17 +54,18 @@ Some examples:
5454
5555``` bash
5656$ cz bump --help
57- usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [--no-verify] [--yes]
58- [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE]
57+ usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [--no-verify]
58+ [--yes] [-- tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE]
5959 [--prerelease {alpha,beta,rc}]
60- [--increment {MAJOR,MINOR,PATCH}]
60+ [--increment {MAJOR,MINOR,PATCH}] [--check-consistency]
6161
6262optional arguments:
6363 -h, --help show this help message and exit
6464 --dry-run show output to stdout, no commit, no modified files
6565 --files-only bump version in the files from the config
6666 --changelog, -ch generate the changelog for the newest version
67- --no-verify this option bypasses the pre-commit and commit-msg hooks
67+ --no-verify this option bypasses the pre-commit and commit-msg
68+ hooks
6869 --yes accept automatically questions done
6970 --tag-format TAG_FORMAT
7071 the format used to tag the commit and read it, use it
@@ -76,18 +77,30 @@ optional arguments:
7677 choose type of prerelease
7778 --increment {MAJOR,MINOR,PATCH}
7879 manually specify the desired increment
80+ --check-consistency, -cc
81+ check consistency among versions defined in commitizen
82+ configuration and version_files
7983```
8084
81- ## Configuration
82-
83- ### ` changelog `
85+ ### ` --changelog `
8486
8587Generate a ** changelog** along with the new version and tag when bumping.
8688
8789``` bash
8890cz bump --changelog
8991```
9092
93+ ### ` --check-consistency `
94+
95+ Check whether the versions defined in ` version_files ` and the version in commitizen
96+ configuration are consistent before bumping version.
97+
98+ ``` bash
99+ cz bump --check-consistency
100+ ```
101+
102+ ## Configuration
103+
91104### ` tag_format `
92105
93106It is used to read the format from the git tags, and also to generate the tags.
0 commit comments