Skip to content

Commit c71773a

Browse files
committed
docs(bump): add description for bump "--allow-no-commit" argument
1 parent 79dfa58 commit c71773a

File tree

3 files changed

+273
-257
lines changed

3 files changed

+273
-257
lines changed

docs/commands/bump.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,18 @@ You should normally not use this functionality, but if you decide to do, keep in
285285
* Version `1.2.3+a`, and `1.2.3+b` are the same version! Tools should not use the string after `+` for version calculation. This is probably not a guarantee (example in helm) even tho it is in the spec.
286286
* It might be problematic having the metadata in place when doing upgrades depending on what tool you use.
287287

288+
### `--allow-no-commit`
289+
290+
Allow the project version to be bumped even when there's no eligible version. This is most useful when used with `--increment {MAJOR,MINOR,PATCH}` or `[MANUL_VERSION]`
291+
292+
```sh
293+
# bump a minor version even when there's only bug fixes, documentation changes or even no commits
294+
cz bump --incremental MINOR --allow-no-commit
295+
296+
# bump version to 2.0.0 even when there's no breaking changes changes or even no commits
297+
cz bump --allow-no-commit 2.0.0
298+
```
299+
288300
## Avoid raising errors
289301

290302
Some situations from commitizen raise an exit code different than 0.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy