From 38655a5eda69df8b0b0cddcadbc1e33083600893 Mon Sep 17 00:00:00 2001 From: Lars Grefer Date: Sat, 28 Oct 2023 05:30:56 +0200 Subject: [PATCH] Improve compatibility documentation fixes #928 --- README.md | 11 ++++++++++- documentation/src/docs/asciidoc/index.adoc | 10 +++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d93d5607..c3ac9889 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,18 @@ Javadoc https://docs.freefair.io/gradle-plugins/current/api/ # Compatibility Matrix +Since version 8, we align our major.minor version with Gradle. + +The plugins itself should work on every Java version on which Gradle works, +but external tools like Lombok or Ajc may have additional constrains. + | Plugin Version | Gradle Version | Java Version | Kotlin Version | |----------------|----------------|--------------|----------------| -| 8.0.x | 8.0 | 8 - 18 | | +| 8.4.x | 8.4 | 8+ | | +| 8.3.x | 8.3 | 8+ | | +| 8.2.x | 8.2 | 8+ | | +| 8.1.x | 8.1 | 8+ | | +| 8.0.x | 8.0 | 8+ | | | 6.6.x | 7.6 | 8 - 18 | 1.7.x | | 6.5.x | 7.5 | 8 - 18 | 1.7.x | | 6.4.x | 7.4 | 8 - 17 | 1.3.x - 1.6.x | diff --git a/documentation/src/docs/asciidoc/index.adoc b/documentation/src/docs/asciidoc/index.adoc index 66204a6e..8f077843 100644 --- a/documentation/src/docs/asciidoc/index.adoc +++ b/documentation/src/docs/asciidoc/index.adoc @@ -89,7 +89,15 @@ apply(plugin = "io.freefair.lombok") == System Requirements -Unless otherwise noted, all plugins require at least Java 8 and are targeted at Gradle {gradle_version}. +=== Gradle + +The plugins of version {revnumber} are targeted at Gradle {gradle_version}. + +Starting with version 8, the _Major.Minor_ version of the plugins matches those of Gradle itself. + +=== Java + +Most of the plugins should work all Java versions supported by Gradle {gradle_version}, but some of the included external tools or libraries like Lombok or AJC might have additional constraints. include::_settings.adoc[]