This document details the version compatibility of components of Gradle Enterprise with other related components.
Gradle Enterprise Gradle plugin
Latest version: 3.13.3 (2023-05-25)
It is recommended to always use the latest version of the Gradle Enterprise Gradle plugin that is compatible with your Gradle Build Tool version and installed Gradle Enterprise version, as it will produce the most insightful build scans. See the Gradle Enterprise Gradle Plugin User Manual for more information on using the Gradle Enterprise Gradle plugin.
This plugin was previously named and referred to as the “build scan” plugin. With the release of Gradle 6.0 and version 3.0 of this plugin, it has been renamed to the “Gradle Enterprise” plugin. When being used with earlier than Gradle 6.0, it is still referred to and used as the “build scan” plugin. |
Gradle Build Tool compatibility
Upgrading your Gradle version may require updating the Gradle Enterprise Gradle plugin version.
Build Scans
For Gradle version 2.0
until 5.6.4
, apply the Build Scan Gradle Plugin as described here. For Gradle 6.0+
, apply the Gradle Enterprise Gradle Plugin as described here.
Gradle Build Tool versions | Minimum plugin version | Maximum plugin version |
---|---|---|
≥ 6.0 |
3.0 |
3.13.3 |
5.0 - 5.6.4 |
2.0.2 |
3.13.3 |
4.1 - 4.10 |
1.8 |
1.16 |
4.0 |
1.7.4 |
1.16 |
2.0 - 3.5 |
1.0 |
1.16 |
< 2.0 |
not supported |
not supported |
Predictive Test Selection and Test Distribution
The minimum version for the Gradle Build Tool that works with Predictive Test Selection and Test Distribution is 5.4.
Gradle Build Tool version | Minimum plugin version | Maximum plugin version |
---|---|---|
≥ 5.4 |
3.11 |
3.13.3 |
< 5.4 |
not supported |
not supported |
The functionality of the Gradle Enterprise Test Distribution Gradle plugin was merged into the Gradle Enterprise Gradle plugin as of version 3.11 as part of the Gradle Enterprise 2022.3 release. Please use the Gradle Enterprise Test Distribution Gradle plugin for Predictive Test Selection and Test Distribution on Gradle Enterprise 2022.2 and earlier. |
Gradle Enterprise compatibility
Major or minor version updates to the Gradle Enterprise Gradle plugin indicate a compatibility change with Gradle Enterprise (e.g. 3.0 → 3.1 or 3.1 → 4.0). Patch number only updates (e.g. 3.0 → 3.0.1) do not affect compatibility.
Submitting a build scan with an incompatible Gradle Enterprise Gradle plugin version will result in a warning message and the submission will be rejected.
Gradle Enterprise versions | Minimum plugin version | Maximum plugin version |
---|---|---|
2023.1 |
1.0 |
3.13.3 |
2022.4 |
1.0 |
3.12.6 |
2022.3 |
1.0 |
3.11.4 |
2022.2 |
1.0 |
3.10.3 |
2022.1 |
1.0 |
3.9 |
2021.4 |
1.0 |
3.8.1 |
2021.3 |
1.0 |
3.7.2 |
2021.1 - 2021.2 |
1.0 |
3.6.4 |
2020.4 - 2020.5 |
1.0 |
3.5.2 |
2020.3 |
1.0 |
3.4.1 |
2020.2 |
1.0 |
3.3.4 |
2020.1 |
1.0 |
3.2.1 |
2019.4 - 2019.5 |
1.0 |
3.1.1 |
2019.3.3 - 2019.3.5 |
1.0 |
3.0 |
2019.3 - 2019.3.2 |
1.0 |
2.4.2 |
2019.2 |
1.0 |
2.3 |
2019.1 |
1.0 |
2.2.1 |
2018.5 |
1.0 |
2.1 |
2018.4.2 |
1.0 |
2.0.2 |
2018.4 - 2018.4.1 |
1.0 |
1.16 |
2018.3 |
1.0 |
1.15.2 |
2018.2 |
1.0 |
1.13.4 |
2018.1 |
1.0 |
1.12.1 |
2017.7 |
1.0 |
1.11 |
2017.6 |
1.0 |
1.10.3 |
2017.5 |
1.0 |
1.9.1 |
2017.4 |
1.0 |
1.8 |
2017.3 |
1.0 |
1.7.4 |
2017.1 - 2017.2 |
1.0 |
1.6 |
2016.4 |
1.0 |
1.3 |
2016.3 |
1.0 |
1.1.1 |
2016.0 - 2016.2 |
1.0 |
1.0 |
Test Retry Gradle plugin
When using the Test Retry Gradle plugin together with the Gradle Enterprise Gradle plugin for Test Distribution or Predictive Test Selection, make sure to use the minimum required version as shown below:
Gradle Enterprise Gradle plugin | Minimum Test Retry plugin version |
---|---|
≥ 3.11 |
1.1.4 |
Gradle Enterprise Maven extension
Latest version: 1.17.2 (2023-05-09)
It is recommended to always use the latest version of the extension that is compatible with your Apache Maven™ version and installed Gradle Enterprise version, as it will produce the most insightful build scans and provide the most performant build caching. See the Gradle Enterprise Maven Extension User Manual for more information on using the extension.
Apache Maven compatibility
The latest version of the extension is guaranteed to be compatible with Apache Maven 3.3.1 onwards.
Apache Maven versions | Minimum extension version | Maximum extension version |
---|---|---|
≥ 4.0.0 |
1.17.3 |
1.17.2 |
≥ 3.3.1 |
1.0 |
1.17.2 |
< 3.3.1 |
not supported |
not supported |
Java runtime requirements
The latest version of the extension runs on Java 1.8 and above.
Java runtime version | Minimum extension version | Maximum extension version |
---|---|---|
≥ 1.8 |
1.0 |
1.17.2 |
< 1.8 |
not supported |
not supported |
Gradle Enterprise compatibility
Major or minor version updates to the extension indicate a compatibility change with Gradle Enterprise (e.g. 1.0 → 1.1 or 1.0 → 2.0). Patch number only updates (e.g. 1.0 → 1.0.1) do not affect compatibility.
Submitting a build scan or accessing the Build Cache with an incompatible extension version will result in a warning message and the submission or request will be rejected.
Gradle Enterprise versions | Minimum extension version | Maximum extension version |
---|---|---|
2023.1 |
1.0 |
1.17.2 |
2022.4 |
1.0 |
1.16.6 |
2022.3 |
1.0 |
1.15.5 |
2022.2 |
1.0 |
1.14.4 |
2022.1 |
1.0 |
1.13.1 |
2021.4 |
1.0 |
1.12.4 |
2021.3 |
1.0 |
1.11.1 |
2021.2 |
1.0 |
1.10.5 |
2021.1 |
1.0 |
1.9.2 |
2020.5 |
1.0 |
1.8.3 |
2020.4 |
1.0 |
1.7.2 |
2020.3 |
1.0 |
1.6.8 |
2020.2 |
1.0 |
1.5.3 |
2020.1 |
1.0 |
1.4.1 |
2019.4 - 2019.5 |
1.0 |
1.3.6 |
2019.3 |
1.0 |
1.2.8 |
2019.2 |
1.0 |
1.1.4 |
2019.1 |
1.0 |
1.0.8 |
< 2019.1 |
not supported |
not supported |
Build cache node
Latest version: 15.0 (2023-04-11)
It is recommended to always use the latest version of the build cache node. See the Build Cache Node User Manual for more information on using and installing a build cache node.
Gradle Enterprise compatibility
Major version updates to the remote cache node indicate a compatibility change with Gradle Enterprise (e.g. 1.0 → 2.0). Minor number only updates (e.g. 3.0 → 3.1) do not affect compatibility.
Gradle Enterprise versions | Minimum build cache node version | Maximum build cache node version |
---|---|---|
2023.1 |
1.0 |
15.0 |
2022.4 |
1.0 |
14.0 |
2022.3 |
1.0 |
13.3 |
2022.1 - 2022.2 |
1.0 |
12.5 |
2021.4 |
1.0 |
11.2 |
2021.3 |
1.0 |
10.3 |
2019.4 - 2021.2 |
1.0 |
9.11 |
2019.3.1 |
1.0 |
8.1 |
2019.1 - 2019.3 |
1.0 |
7.1 |
2018.5 |
1.0 |
6.0 |
2018.4 |
1.0 |
5.2 |
2018.2 - 2018.3 |
1.0 |
4.3 |
2017.7 - 2018.1 |
1.0 |
3.2 |
2017.6 |
1.0 |
2.0 |
2017.4 - 2017.5 |
1.0 |
1.2 |
< 2017.4 |
not supported |
not supported |
Configuration schema
The YAML configuration schema is released at a different rate to that of the node. Nodes will always parse configuration files with a version less than the maximum schema version.
Schema versions can be downloaded from the build cache node manual Appendix B.
Build cache node version | Maximum schema version |
---|---|
≥ 12.0 |
5 |
11.0 - 11.2 |
4 |
10.0 - 10.3 |
3 |
6.0 - 9.11 |
2 |
4.2 - 5.2 |
1 |
< 4.2 |
not supported |
Jar version Java runtime requirements
Since build cache node 15.0 we require a Java 17 runtime to run the JAR version of the build cache node. Prior to this, Java 11 was required.
Build cache node version | Minimum Java runtime version |
---|---|
≥ 15.0 |
17 |
9.0 - 14.0 |
11 |
< 9.0 |
8 |
Gradle Enterprise Test Distribution Gradle plugin
The functionality of the Gradle Enterprise Test Distribution Gradle plugin was merged into the Gradle Enterprise Gradle plugin as of version 3.11 as part of the Gradle Enterprise 2022.3 release. |
Last version: 2.3.5 (2022-07-01)
Gradle Enterprise compatibility
Gradle Enterprise 2020.2 is the first release that supports Test Distribution.
Gradle Enterprise versions | Minimum plugin version | Maximum plugin version |
---|---|---|
≥ 2022.2 |
1.1 |
2.3.5 |
2021.3 - 2022.1 |
1.1 |
2.2.3 |
2021.2 |
1.1 |
2.1.1 |
2021.1 |
1.1 |
2.0.3 |
2020.5 |
1.1 |
1.3.3 |
2020.4 |
1.1 |
1.2.1 |
2020.3 |
1.1 |
1.1.5 |
2020.2 |
1.0 |
1.0.2 |
< 2020.2 |
not supported |
not supported |
Gradle Build Tool compatibility
The minimum version for the Gradle Build Tool which works with Test Distribution is 5.4.
Gradle Build Tool version | Minimum plugin version | Maximum plugin version |
---|---|---|
≥ 7.6 |
2.3.4 |
2.3.5 |
6.8 - 7.5 |
1.3 |
2.3.5 |
6.7 |
1.1.2 |
2.3.5 |
5.4 - 6.6 |
1.0 |
2.3.5 |
< 5.4 |
not supported |
not supported |
Test Retry Gradle plugin
When using the Test Retry Gradle plugin together with the Gradle Enterprise Test Distribution Gradle plugin, make sure to use the minimum required version as shown below:
Gradle Enterprise Test Distribution Gradle plugin | Minimum Test Retry plugin version |
---|---|
≥ 1.0 |
1.1.4 |
Gradle Enterprise Test Distribution agent
Latest version: 2.0.1 (2023-05-03)
It is recommended to always use the latest version of the Gradle Enterprise Test Distribution agent. See the Gradle Enterprise Test Distribution Agent User Manual for more information on using and installing a Test Distribution agent.
Gradle Enterprise compatibility
Gradle Enterprise 2020.2 is the first release which supports Test Distribution.
Gradle Enterprise versions | Minimum agent version | Maximum agent version |
---|---|---|
2023.1 |
1.1 |
2.0.1 |
2021.3 - 2022.4 |
1.1 |
1.6.14 |
2021.2 |
1.1 |
1.5 |
2021.1 |
1.1 |
1.4.1 |
2020.5 |
1.1 |
1.3.2 |
2020.4 |
1.1 |
1.2 |
2020.3 |
1.1 |
1.1.2 |
2020.2 |
1.0 |
1.0 |
< 2020.2 |
not supported |
not supported |
Jar version Java runtime requirements
The Gradle Enterprise Test Distribution agent requires a Java 17 runtime.
Test Distribution Agent | Minimum Java runtime version |
---|---|
≥ 2.0 |
17 |
1.0 - 1.6.14 |
11 |
Gradle Enterprise Admin CLI tool
Latest version: 1.7.2 (2023-05-09)
Some Admin CLI commands are self-contained and do not connect to a Gradle Enterprise instance. These can be run regardless of the installed Gradle Enterprise version.
For commands that connect to a Gradle Enterprise instance, see the table below.
It is recommended to always use the latest version of the Gradle Enterprise Admin CLI tool. See the Gradle Enterprise Admin CLI User Manual for more information on using and installing the tool.
Gradle Enterprise distribution compatibility
Gradle Enterprise distribution | Minimum tool version |
---|---|
Helm standalone |
1.2 |
Helm |
1.2 |
Replicated Appliance |
not supported |
Replicated Ship / Kubernetes |
not supported |
Gradle Enterprise compatibility
Gradle Enterprise 2021.4 is the first release which supports connections from the Gradle Enterprise Admin CLI tool.
Gradle Enterprise versions | Minimum tool version | Maximum agent version |
---|---|---|
2022.4 |
1.6 |
1.7.2 |
2022.2 - 2022.3 |
1.3 |
1.5.1 |
2021.4 - 2022.1 |
1.2 |
1.7.2 |
< 2021.4 |
not supported |
not supported |
Jar version Java runtime requirements
The Gradle Enterprise Test Distribution agent requires a Java 11 runtime.
Gradle Enterprise Admin CLI tool | Minimum Java runtime version |
---|---|
≥ 1.0 |
11 |
Gradle Enterprise upgrade and backup restoration compatibility
Some older versions of Gradle Enterprise need to be upgraded via an intermediate version. The same behaviour applies to backups from older versions that are restored - these need the same upgrade compatibility to the current version as upgrading a Gradle Enterprise installation in-place.
At this time, all versions prior to 2018.5 must be upgraded via an intermediate version. In some rare circumstances later versions up to 2020.1.2 may also need an intermediate version, depending on database state. All other versions can be upgraded to the latest Gradle Enterprise directly.
If your installation needs an intermediate version installed in order to upgrade to the latest version, a message will be displayed (or signed in Kubernetes installations) when attempting to start the new Gradle Enterprise version, indicating that the previous version is not upgrade-compatible with the current version, and to contact Gradle support. A step-by-step process will then be provided by Gradle support to install the necessary intermediate version and finish any incomplete data migration, before then upgrading to the latest version.