You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/bump.md
+22
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,7 @@ optional arguments:
64
64
--dry-run show output to stdout, no commit, no modified files
65
65
--files-only bump version in the files from the config
66
66
--changelog, -ch generate the changelog for the newest version
67
+
--no-changelog, -nch do not generate changelog when config defaults to doing so
67
68
--no-verify this option bypasses the pre-commit and commit-msg
68
69
hooks
69
70
--yes accept automatically questions done
@@ -90,6 +91,14 @@ Generate a **changelog** along with the new version and tag when bumping.
90
91
cz bump --changelog
91
92
```
92
93
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
+
93
102
### `--check-consistency`
94
103
95
104
Check whether the versions defined in `version_files` and the version in commitizen
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
+
219
241
## Custom bump
220
242
221
243
Read the [customizing section](./customization.md).
0 commit comments