From 00b733b056534c0fbdb316bbd37c023e7bb80905 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Cerqueira?= Date: Fri, 14 Jul 2023 18:07:54 +0100 Subject: [PATCH] docs: fix force-patch-increment flag usage (#122) --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cdac990..e9894a2 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ v1.3.0-alpha.3+243 Increases the patch of the latest tag and prints it. As per the [Semver][] spec, if the version has a `pre-release` or `build` identifier, they'll be cleaned up and no patch increment will be made. -You can force an increment by using `--force-patch-increment`. +You can force a patch increment by using `svu next --force-patch-increment`. > alias: `svu p` @@ -105,11 +105,11 @@ v1.2.3-alpha.2+123 $ svu patch v1.2.3 -$ svu patch --force-patch-increment -v1.2.4 - $ svu patch --pre-release alpha.3 --build 243 v1.2.3-alpha.3+243 + +$ svu next --force-patch-increment +v1.2.4 ``` ## tag mode @@ -138,6 +138,12 @@ identifiers to the resulting version. Setting the `--force-patch-increment` flag forces a patch version increment regardless of the commit message content. +**Example:** + +```bash +svu next --force-patch-increment +``` + ## creating tags The idea is that `svu` will just print things, so it's safe to run at any time.