Skip to content

Commit

Permalink
Improve compatibility documentation
Browse files Browse the repository at this point in the history
fixes #928
  • Loading branch information
larsgrefer committed Oct 28, 2023
1 parent e29db28 commit 38655a5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
10 changes: 9 additions & 1 deletion documentation/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down

0 comments on commit 38655a5

Please sign in to comment.