Skip to content

Commit

Permalink
docs: fix force-patch-increment flag usage (#122)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcrqr authored Jul 14, 2023
1 parent 54dc19e commit 00b733b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 00b733b

Please sign in to comment.