Skip to content

Commit 6c68649

Browse files
author
Joel Mongård
committed
docs(README): Updated documentation
1 parent eeab899 commit 6c68649

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ def ver = semver.version
2727
allprojects {
2828
version = ver
2929
}
30-
// Note: Using `allprojects` with configuration cache is currently not supported by Gradle.
31-
// If you plan to use configuration cache, apply the plugin to each subproject separately.
3230
3331
```
3432

3533
[For the latest published version see the plugins page at Gradle.org](https://plugins.gradle.org/plugin/com.github.jmongard.git-semver-plugin)
3634

37-
The plugin requires java version 17 to run. (Use version `0.13.0` if Java 8 is required.)
35+
The plugin requires Gradle 8 and Java version 17 to run.
36+
(Use version `0.16.1` if Gradle 7 is required.)
37+
(Use version `0.13.0` if Java 8 is required.)
3838

3939
## Versioning
4040

@@ -259,6 +259,7 @@ semver {
259259
gitDirectory = project.projectDir
260260
createReleaseCommit = true
261261
createReleaseTag = true
262+
metaSeparator = '+'
262263
}
263264
264265
//Remember to retrieve the version after plugin has been configured
@@ -286,6 +287,7 @@ version = semver.version
286287
has the same effect as the --no-tag flag.
287288
* **createReleaseCommit**: If a release commit should be created when running the release task. Setting this to false
288289
has the same effect as the --no-commit flag.
290+
* **metaSeparator**: The character to use to separate build metadata from the version when printing info version.
289291

290292
Patterns is matched using [java regular expressions](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html)
291293
with IGNORE_CASE and MULTILINE options enabled.

0 commit comments

Comments
 (0)