Skip to content

Commit

Permalink
docs(bump): add description for bump "--allow-no-commit" argument
Browse files Browse the repository at this point in the history
  • Loading branch information
Lee-W committed May 20, 2024
1 parent 79dfa58 commit c71773a
Show file tree
Hide file tree
Showing 3 changed files with 273 additions and 257 deletions.
12 changes: 12 additions & 0 deletions docs/commands/bump.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,18 @@ You should normally not use this functionality, but if you decide to do, keep in
* 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.
* It might be problematic having the metadata in place when doing upgrades depending on what tool you use.

### `--allow-no-commit`

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]`

```sh
# bump a minor version even when there's only bug fixes, documentation changes or even no commits
cz bump --incremental MINOR --allow-no-commit

# bump version to 2.0.0 even when there's no breaking changes changes or even no commits
cz bump --allow-no-commit 2.0.0
```

## Avoid raising errors

Some situations from commitizen raise an exit code different than 0.
Expand Down
Loading

0 comments on commit c71773a

Please sign in to comment.