Skip to content

Commit f309117

Browse files
committed
docs(README): Updated with information on required Java version and when task are registered.
1 parent 95ffe2e commit f309117

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ allprojects {
3434

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

37+
The plugin requires java version 17 to run. (Use version `0.13.0` if Java 8 is required.)
3738

3839
## Versioning
3940

@@ -139,6 +140,8 @@ to an UTF-8 encoded file using `--file <filename>` e.g. `./gradlew printChangeLo
139140
Note: Use an absolute path for filename as the working directory might not be the one you expect if running
140141
using gradle deamon.
141142

143+
Note: The `printChangeLog` task is currently only registered on the root project given that the plugin is applied there.
144+
142145
````shell
143146
$ gradlew printChangeLog
144147

@@ -167,6 +170,7 @@ fail with an error if there exists local modification. It is possible to change
167170
* **--preRelease**="pre-release": Change the current pre-release e.g. `--preRelease=alpha.1`.
168171
Set the pre-release to "-" e.g. `--preRelease=-` to promote a pre-release to a release.
169172

173+
Note: The `releaseVersion` task is currently only registered on the root project given that the plugin is applied there.
170174

171175
## Example of how version is calculated
172176
With setting: `groupVersionIncrements = true` (default)

0 commit comments

Comments
 (0)