You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,16 +29,16 @@ A tooling and language agnostic utility to calculate the next semantic version b
29
29
30
30
## Usage
31
31
Conventional Commits Next Version can either operate upon a range of Git commits in the repositories' history or on a commit message provided by standard in.
32
-
To provide a commit message by standard in simple add the flag `--from-stdin` and standard in will be read.
33
-
Otherwise to specify the range of commits you can add either the `--from-commit-hash <commit-hash>` or `--from-reference <reference>` arguments.
32
+
To provide a commit message by standard in, use a hyphen (`-`) as the final positional argument.
33
+
Otherwise, to specify the range of commits, provide a commit reference (sha, tag, etc.) as the final positional argument.
34
34
The range of commits starts exclusively from the commit specified till inclusively of `HEAD`.
35
35
36
36
Any commits which conform to the Conventional Commits v1.0.0 specification are used to calculate the next Semantic Versioning, based upon the initial semantic version provided via the argument `--from-version <version>`.
37
37
38
-
The only required arguments is`--from-version <version>` and any of `--from-stdin`, `--from-commit-hash <commit-hash>`or `--from-reference <reference>` arguments.
38
+
The only required arguments are`--from-version <version>` and a final positional argument specifying either the commit reference (sha, tag, etc.) to start the calculation from, or a hyphen (`-`) to read from standard in.
39
39
40
40
The next semantic version can be calculated using a variety of calculation modes.
41
-
Currently there are two modes, consecutive and batch mode.
41
+
Currently there are two modes: consecutive and batch mode.
0 commit comments