Skip to content

Commit 33f9ccb

Browse files
committed
docs(bump): document usage of the update_changelog_on_bump flag
1 parent 249e7cc commit 33f9ccb

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/bump.md

+13
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,19 @@ Some examples
216216
bump_message = "release $current_version → $new_version [skip-ci]"
217217
```
218218

219+
---
220+
221+
### `update_changelog_on_bump`
222+
223+
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.
224+
225+
defaults to: `false`
226+
227+
```toml
228+
[tool.commitizen]
229+
update_changelog_on_bump = true
230+
```
231+
219232
## Custom bump
220233

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

0 commit comments

Comments
 (0)