Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit a651ec1

Browse files
docs(bump): update bump documentation
1 parent 42e4361 commit a651ec1

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/bump.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Some examples:
5454

5555
```bash
5656
$ cz bump --help
57-
usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [--no-verify]
57+
usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [--no-verify] [--local-version]
5858
[--yes] [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE]
5959
[--prerelease {alpha,beta,rc}]
6060
[--increment {MAJOR,MINOR,PATCH}] [--check-consistency]
@@ -67,6 +67,7 @@ optional arguments:
6767
--no-verify this option bypasses the pre-commit and commit-msg
6868
hooks
6969
--yes accept automatically questions done
70+
--local-version bump the local portion of the version
7071
--tag-format TAG_FORMAT
7172
the format used to tag the commit and read it, use it
7273
in existing projects, wrap around simple quotes
@@ -131,6 +132,24 @@ However, it will still update `pyproject.toml` and `src/__version__.py`.
131132
To fix it, you'll first `git checkout .` to reset to the status before trying to bump and update
132133
the version in `setup.py` to `1.21.0`
133134

135+
136+
### `--local-version`
137+
138+
Bump the local portion of the version.
139+
140+
```bash
141+
cz bump --local-version
142+
```
143+
144+
For example, if we have `pyproject.toml`
145+
146+
```toml
147+
[tool.commitizen]
148+
version = "5.3.5+0.1.0"
149+
```
150+
151+
If `--local-version` is used, it will bump only the local version `0.1.0` and keep the public version `5.3.1` intact, bumping to the version `5.3.5+0.2.0`.
152+
134153
## Configuration
135154

136155
### `tag_format`

0 commit comments

Comments
 (0)