Skip to content

Commit d6e394a

Browse files
marcelblijlevenLee-W
authored andcommitted
docs(bump): add comparison between --get-next and --dry-run
1 parent 9e18b63 commit d6e394a

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

Diff for: docs/commands/bump.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,26 @@ cz bump --get-next
297297
Will output the next version, e.g. `1.2.3`. This can be useful for determining the next version based in CI for non
298298
production environments/builds.
299299

300-
It will raise a `NoneIncrementExit` if the commits found are not eligible for a version bump.
301-
See [avoid raising errors](#avoid-raising-errors) for information on suppressing this exit.
300+
This behavior differs from the `--dry-run` flag. The `--dry-run` flag provides a more detailed output and can also show
301+
the changes as they would appear in the changelog file.
302+
303+
The following output is the result of `cz bump --dry-run`:
304+
305+
```
306+
bump: version 3.28.0 → 3.29.0
307+
tag to create: v3.29.0
308+
increment detected: MINOR
309+
```
310+
311+
The following output is the result of `cz bump --get-next`:
312+
313+
```
314+
3.29.0
315+
```
316+
317+
The `--get-next` flag will raise a `NoneIncrementExit` if the found commits are not eligible for a version bump.
318+
319+
For information on how to suppress this exit, see [avoid raising errors](#avoid-raising-errors).
302320

303321
## Avoid raising errors
304322

0 commit comments

Comments
 (0)