Skip to content

Commit 223fe80

Browse files
author
Jan Willhaus
committed
docs(bump): document usage of the update_changelog_on_bump flag
1 parent 1cbcff6 commit 223fe80

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/bump.md

+22
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ optional arguments:
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-changelog, -nch do not generate changelog when config defaults to doing so
6768
--no-verify this option bypasses the pre-commit and commit-msg
6869
hooks
6970
--yes accept automatically questions done
@@ -90,6 +91,14 @@ Generate a **changelog** along with the new version and tag when bumping.
9091
cz bump --changelog
9192
```
9293

94+
### `--no-changelog`
95+
96+
Disable generating a **changelog** along with the new version. This is useful when `update_changelog_on_bump` configuration option is set but should be disabled for the new version.
97+
98+
```bash
99+
cz bump --no-changelog
100+
```
101+
93102
### `--check-consistency`
94103

95104
Check whether the versions defined in `version_files` and the version in commitizen
@@ -216,6 +225,19 @@ Some examples
216225
bump_message = "release $current_version → $new_version [skip-ci]"
217226
```
218227

228+
---
229+
230+
### `update_changelog_on_bump`
231+
232+
When set to `true` the changelog is always updated incrementally when running `cz bump`, so the user does not have to provide the `--changelog` flag every time.
233+
234+
defaults to: `false`
235+
236+
```toml
237+
[tool.commitizen]
238+
update_changelog_on_bump = true
239+
```
240+
219241
## Custom bump
220242

221243
Read the [customizing section](./customization.md).

0 commit comments

Comments
 (0)