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
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,6 @@ For those who don't know the plugin, it basically helps you with the following t
8
8
Getting the plugin
9
9
==================
10
10
The plugin **unreleased**!
11
-
Future version might be released to Maven Central ([see here](https://search.maven.org/artifact/io.github.git-commit-id/git-commit-id-gradle-plugin)), so you don't have to configure any additional repositories to use this plugin.
12
11
13
12
Using the plugin
14
13
==================
@@ -58,14 +57,20 @@ The current version is **unreleased**
58
57
59
58
Plugin compatibility with Gradle
60
59
-----------------------------
61
-
This project requires at least 11 java and will rely on gradle's convention for configuration
62
-
63
-
With [Gradle's Compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html) the
64
-
minimum supported gradle version is 5.0.
65
-
Unfortunately conventions only had been introduced with [gradle 5.1](https://docs.gradle.org/5.1/release-notes.html)
66
-
so that is as of now the minimal supported version.
67
-
68
-
**TODO** test this assumption and make a pretty table
60
+
This project requires *at least java 11* and will rely on gradle's convention for configuration.
61
+
You also will need *at least a gradle 5.3** installation to be able to use this plugin.
62
+
63
+
In case you are interested here are more details about the specifics for the version requirements:
64
+
- The [git-commit-id-plugin-core](https://github.com/git-commit-id/git-commit-id-plugin-core)
65
+
which provides the core functions for gathering the git information relies on [JGit](https://wiki.eclipse.org/JGit)
66
+
that is a pure Java library implementing the Git version control file access routines.
67
+
With version [6.0](https://wiki.eclipse.org/JGit/New_and_Noteworthy/6.0) this library requires Java 11 to run.
68
+
- With [Gradle's Compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html) the
69
+
minimum supported gradle version is 5.0.
70
+
- This plugin relies on conventions that had been introduced as part of the [Lazy Configuration](https://docs.gradle.org/current/userguide/lazy_configuration.html).
71
+
Such conventions had been made available with [gradle 5.1](https://docs.gradle.org/5.1/release-notes.html)
72
+
- The GitCommitIdPluginExtension is made abstract and uses an `Injection` annotation that only
73
+
works with gradle 5.3 and onwards. For more details refer to https://github.com/gradle/gradle/issues/24947.
0 commit comments