Skip to content

Commit 6940241

Browse files
committed
docs(bump): add information about changelog
1 parent 9b40799 commit 6940241

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/bump.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Some examples:
5454

5555
```bash
5656
$ cz bump --help
57-
usage: cz bump [-h] [--dry-run] [--files-only] [--yes]
57+
usage: cz bump [-h] [--dry-run] [--files-only] [--changelog] [--yes]
5858
[--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE]
5959
[--prerelease {alpha,beta,rc}]
6060
[--increment {MAJOR,MINOR,PATCH}]
@@ -63,10 +63,11 @@ optional arguments:
6363
-h, --help show this help message and exit
6464
--dry-run show output to stdout, no commit, no modified files
6565
--files-only bump version in the files from the config
66+
--changelog, -ch generate the changelog for the newest version
6667
--yes accept automatically questions done
6768
--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
7071
--bump-message BUMP_MESSAGE
7172
template used to create the release commmit, useful
7273
when working with CI
@@ -78,6 +79,14 @@ optional arguments:
7879

7980
## Configuration
8081

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+
8190
### `tag_format`
8291

8392
It is used to read the format from the git tags, and also to generate the tags.

0 commit comments

Comments
 (0)