@@ -54,7 +54,7 @@ Some examples:
54
54
55
55
``` bash
56
56
$ cz bump --help
57
- usage: cz bump [-h] [--dry-run] [--files-only] [--yes]
57
+ usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [-- yes]
58
58
[--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE]
59
59
[--prerelease {alpha,beta,rc}]
60
60
[--increment {MAJOR,MINOR,PATCH}]
@@ -63,10 +63,11 @@ optional arguments:
63
63
-h, --help show this help message and exit
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
+ --changelog, -ch generate the changelog for the newest version
66
67
--yes accept automatically questions done
67
68
--tag-format TAG_FORMAT
68
- the format used to tag the commit and read it, use it in
69
- existing projects, wrap around simple quotes
69
+ the format used to tag the commit and read it, use it
70
+ in existing projects, wrap around simple quotes
70
71
--bump-message BUMP_MESSAGE
71
72
template used to create the release commmit, useful
72
73
when working with CI
@@ -78,6 +79,14 @@ optional arguments:
78
79
79
80
## Configuration
80
81
82
+ ### ` changelog `
83
+
84
+ Generate a ** changelog** along with the new version and tag when bumping.
85
+
86
+ ``` bash
87
+ cz bump --changelog
88
+ ```
89
+
81
90
### ` tag_format `
82
91
83
92
It is used to read the format from the git tags, and also to generate the tags.
0 commit comments