Skip to content

Commit 25c0327

Browse files
LuisHenriLee-W
authored andcommitted
docs(bump): add documentation for annotated tag message
1 parent 9d0fb0b commit 25c0327

File tree

1 file changed

+16
-22
lines changed

1 file changed

+16
-22
lines changed

docs/bump.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,10 @@ Some examples of pep440:
5252

5353
```bash
5454
$ cz bump --help
55-
usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog]
56-
[--no-verify] [--yes] [--tag-format TAG_FORMAT]
57-
[--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}]
58-
[--devrelease DEVRELEASE] [--increment {MAJOR,MINOR,PATCH}]
59-
[--check-consistency] [--annotated-tag] [--gpg-sign]
60-
[--changelog-to-stdout] [--git-output-to-stderr] [--retry] [--major-version-zero]
61-
[--template TEMPLATE] [--extra EXTRA]
55+
usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog] [--no-verify] [--yes] [--tag-format TAG_FORMAT]
56+
[--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] [--increment {MAJOR,MINOR,PATCH}]
57+
[--check-consistency] [--annotated-tag] [--gpg-sign] [--changelog-to-stdout] [--git-output-to-stderr] [--retry] [--major-version-zero]
58+
[--prerelease-offset PRERELEASE_OFFSET] [--version-scheme {semver,pep440}] [--version-type {semver,pep440}]
6259
[MANUAL_VERSION]
6360

6461
positional arguments:
@@ -70,24 +67,20 @@ options:
7067
--files-only bump version in the files from the config
7168
--local-version bump only the local version portion
7269
--changelog, -ch generate the changelog for the newest version
73-
--no-verify this option bypasses the pre-commit and commit-msg
74-
hooks
70+
--no-verify this option bypasses the pre-commit and commit-msg hooks
7571
--yes accept automatically questions done
7672
--tag-format TAG_FORMAT
77-
the format used to tag the commit and read it, use it
78-
in existing projects, wrap around simple quotes
73+
the format used to tag the commit and read it, use it in existing projects, wrap around simple quotes
7974
--bump-message BUMP_MESSAGE
80-
template used to create the release commit, useful
81-
when working with CI
75+
template used to create the release commit, useful when working with CI
8276
--prerelease {alpha,beta,rc}, -pr {alpha,beta,rc}
8377
choose type of prerelease
8478
--devrelease DEVRELEASE, -d DEVRELEASE
8579
specify non-negative integer for dev. release
8680
--increment {MAJOR,MINOR,PATCH}
8781
manually specify the desired increment
8882
--check-consistency, -cc
89-
check consistency among versions defined in commitizen
90-
configuration and version_files
83+
check consistency among versions defined in commitizen configuration and version_files
9184
--annotated-tag, -at create annotated tag instead of lightweight one
9285
--gpg-sign, -s sign tag instead of lightweight one
9386
--changelog-to-stdout
@@ -96,14 +89,12 @@ options:
9689
Redirect git output to stderr
9790
--retry retry commit if it fails the 1st time
9891
--major-version-zero keep major version at zero, even for breaking changes
99-
--prerelease-offset start pre-releases with this offset
100-
--version-scheme {pep440,semver}
92+
--prerelease-offset PRERELEASE_OFFSET
93+
start pre-releases with this offset
94+
--version-scheme {semver,pep440}
10195
choose version scheme
102-
103-
--template TEMPLATE, -t TEMPLATE
104-
changelog template file name (relative to the current working directory)
105-
--extra EXTRA, -e EXTRA
106-
a changelog extra variable (in the form 'key=value')
96+
--version-type {semver,pep440}
97+
Deprecated, use --version-scheme
10798
```
10899
109100
### `--files-only`
@@ -184,6 +175,9 @@ If `--local-version` is used, it will bump only the local version `0.1.0` and ke
184175
185176
If `--annotated-tag` is used, commitizen will create annotated tags. Also available via configuration, in `pyproject.toml` or `.cz.toml`.
186177
178+
### `--annotated-tag-message`
179+
If `--annotated-tag-message` is used, commitizen will create annotated tags with the given message.
180+
187181
### `--changelog-to-stdout`
188182
189183
If `--changelog-to-stdout` is used, the incremental changelog generated by the bump

0 commit comments

Comments
 (0)