From d6e394a8e4949b832a15ac18466b99e46daa63d1 Mon Sep 17 00:00:00 2001 From: Marcel Blijleven Date: Thu, 1 Aug 2024 22:01:54 +0200 Subject: [PATCH] docs(bump): add comparison between --get-next and --dry-run --- docs/commands/bump.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/commands/bump.md b/docs/commands/bump.md index 1bd85025b..fabae4894 100644 --- a/docs/commands/bump.md +++ b/docs/commands/bump.md @@ -297,8 +297,26 @@ cz bump --get-next Will output the next version, e.g. `1.2.3`. This can be useful for determining the next version based in CI for non production environments/builds. -It will raise a `NoneIncrementExit` if the commits found are not eligible for a version bump. -See [avoid raising errors](#avoid-raising-errors) for information on suppressing this exit. +This behavior differs from the `--dry-run` flag. The `--dry-run` flag provides a more detailed output and can also show +the changes as they would appear in the changelog file. + +The following output is the result of `cz bump --dry-run`: + +``` +bump: version 3.28.0 → 3.29.0 +tag to create: v3.29.0 +increment detected: MINOR +``` + +The following output is the result of `cz bump --get-next`: + +``` +3.29.0 +``` + +The `--get-next` flag will raise a `NoneIncrementExit` if the found commits are not eligible for a version bump. + +For information on how to suppress this exit, see [avoid raising errors](#avoid-raising-errors). ## Avoid raising errors