Update README (#481)

* Update README * Update README.adoc Co-authored-by: Guy Brand <[email protected]> --------- Co-authored-by: Guy Brand <[email protected]>
jenkinsci · Sep 18, 2024 · 60d5478 · 60d5478
1 parent 6df8a39
commit 60d5478
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 41 deletions.
diff --git a/README.adoc b/README.adoc
@@ -131,6 +131,11 @@ The auto-injection is split into several levels to have fine-grained control ove
 =====
 Develocity `2024.1` or above is required starting from version `2.12` and above. See <<_short_lived_access_tokens>> for more infos.
 =====
+[IMPORTANT]
+=====
+Starting from plugin version `2.13`, the Maven extension is not bundled with the Jenkins Gradle plugin and requires an explicit version configuration to be injected.
+When upgrading from an earlier version, the injection will be turned off until the version is configured.
+=====
 
 ==== Global
 
@@ -185,11 +190,11 @@ Optionally set the desired version of the https://github.com/gradle/common-custo
 
 ==== Maven
 
-To enable the auto-injection for Maven builds, click the `Enable Develocity Maven extension auto-injection` checkbox in the `Maven settings` section of the configuration form.
+To enable the auto-injection for Maven builds, set the desired https://docs.gradle.com/enterprise/maven-extension/[Develocity Maven extension] version in the `Develocity Maven extension version` field in the `Maven settings` section of the configuration form.
 
 image::maven-settings.png[Maven settings,{thumbnail}]
 
-Optionally click the `Enable Common Custom User Data Maven extension auto-injection` checkbox to enable the auto-injection of the https://github.com/gradle/common-custom-user-data-maven-extension[Common Custom User Data Maven Extension].
+Optionally set the desired version of the https://github.com/gradle/common-custom-user-data-maven-extension[Common Custom User Data Maven Extension] to be used.
 
 To see which versions are injected, refer to <<Auto-injection compatibility>>.
 
@@ -209,7 +214,7 @@ To disable the auto-injection for Gradle builds, remove the `Develocity Gradle p
 
 ==== Maven
 
-To disable the auto-injection for Maven builds, uncheck the `Enable Develocity Maven extension auto-injection` checkbox in the `Maven settings` section of the configuration form.
+To disable the auto-injection for Maven builds, remove the `Develocity Maven extension version` in the `Maven settings` section of the configuration form.
 
 === Control auto-injection based on node labels
 
@@ -234,9 +239,9 @@ The URL of the Develocity instance.
 `Allow untrusted server` +
 Whether to allow publishing to a server with a self-signed certificate.
 
-`Develocity access key` +
-The access key for authenticating with the Develocity server.
-The access key is stored encrypted within the Jenkins instance. During the job execution, the access key is decrypted and used to get a short-lived token from the Develocity server.
+`Develocity Access Key credential ID` +
+The credential ID of the access key for authenticating with the Develocity server.
+During the job execution, the access key is used to get a short-lived token from the Develocity server.
 
 [#_short_lived_access_tokens]
 ==== Short-lived access tokens
@@ -257,6 +262,9 @@ Defines which version of the https://github.com/gradle/common-custom-user-data-g
 The URL of the repository to use to resolve the Develocity Gradle plugin and the Common Custom User Data Gradle plugin.
 This is required if the Jenkins agents are not able to access the https://plugins.gradle.org[Gradle Plugin Portal].
 
+`Gradle plugin repository credential ID` +
+The credentials containing username and password for a custom Gradle Plugin repository.
+
 `Gradle auto-injection enabled nodes` +
 A list of node labels on which the Develocity Gradle plugin or Common Custom User Data Gradle plugin injection should be enabled.
 By default, all nodes are enabled.
@@ -267,11 +275,18 @@ By default, all nodes are enabled.
 
 ==== Maven specific configuration options
 
-`Enable Develocity Maven extension auto-injection` +
-Enables auto-injection for Maven builds and injects https://docs.gradle.com/enterprise/maven-extension[Develocity Maven extension].
+`Develocity Maven extension version` +
+Enables auto-injection for Maven builds and defines which version of the https://docs.gradle.com/enterprise/maven-extension/[Develocity Maven extension] to use.
+
+`Common Custom User Data Maven extension version` +
+Defines which version of the https://github.com/gradle/common-custom-user-data-data-maven-extension[Common Custom User Data Maven extension].
 
-`Enable Common Custom User Data Maven extension auto-injection` +
-Enables auto-injection of https://github.com/gradle/common-custom-user-data-maven-extension[Common Custom User Data Maven extension].
+`Maven extension repository url` +
+The URL of the repository to use to resolve the Develocity Maven Extension and the Common Custom User Data Maven extension.
+This is required if the Jenkins agents are not able to access the https://repo1.maven.org/maven2[Maven Central].
+
+`Maven extension repository credential ID` +
+The credentials containing username and password for a custom Maven repository.
 
 `Maven auto-injection enabled nodes` +
 A list of node labels where the Develocity Maven extension or Common Custom User Data Maven extension injection should be enabled.
@@ -292,36 +307,13 @@ The compatibility of the specified version with Develocity can be found https://
 For the optional Common Custom User Data Gradle plugin which is defined the same form, you can see the compatibility of the specified version with the Develocity Gradle plugin https://github.com/gradle/common-custom-user-data-gradle-plugin#version-compatibility[here].
 
 ==== For Maven builds
-For Maven builds the version of the Develocity Maven extension is bundled into the plugin, meaning that the user can’t change what version is injected into the Maven build.
-
-The following table shows the compatibility of the plugin version with Develocity:
-
-|===
-|Jenkins Gradle Plugin version  | Injected Develocity Maven extension version        | Injected Common Custom User Data Maven extension version  | Minimum supported Develocity version
-|Next version                   | 1.22                                               | 2.0.1                                                     | 2024.2
-|2.12.1                         | 1.22                                               | 2.0                                                       | 2024.2
-|2.12                           | 1.21.3                                             | 2.0                                                       | 2024.1
-|2.11                           | 1.21.1                                             | 2.0                                                       | 2024.1
-|2.10                           | 1.20.1                                             | 1.12.5                                                    | 2023.4
-|2.9                            | 1.19.3                                             | 1.12.4                                                    | 2023.3
-|2.8.2                          | 1.18.1                                             | 1.12.2                                                    | 2023.2
-|2.8.1                          | 1.17.3                                             | 1.12                                                      | 2023.1
-|2.8                            | 1.17.3                                             | 1.12                                                      | 2023.1
-|2.7                            | 1.17.2                                             | 1.11.1                                                    | 2023.1
-|2.6                            | 1.17.1                                             | 1.11.1                                                    | 2023.1
-|2.5.1                          | 1.17                                               | 1.11.1                                                    | 2023.1
-|2.5                            | 1.17                                               | 1.11.1                                                    | 2023.1
-|2.4                            | 1.16.6                                             | 1.11.1                                                    | 2022.4
-|2.3.2                          | 1.16.5                                             | 1.11.1                                                    | 2022.4
-|2.3.1                          | 1.16.5                                             | 1.11.1                                                    | 2022.4
-|2.3                            | 1.16.4                                             | 1.11.1                                                    | 2022.4
-|2.2                            | 1.16.1                                             | 1.11.1                                                    | 2022.4
-|2.1.1                          | 1.15.5                                             | 1.11.1                                                    | 2022.3
-|2.1                            | 1.15.4                                             | 1.11.1                                                    | 2022.3
-|2.0                            | 1.15.4                                             | 1.11.1                                                    | 2022.3
-|1.40                           | 1.15.3                                             | 1.11.1                                                    | 2022.3
-|< 1.40                         | *Not supported*                                    | *Not supported*                                           | *Not supported*
-|===
+For Maven builds the version used for the Develocity Maven extension is defined in the `Develocity Maven extension version` field in the `Maven settings` section of the configuration form.
+See <<Enable auto-injection>> for details.
+The compatibility of the specified version with Develocity can be found https://docs.gradle.com/enterprise/compatibility/#maven_extension[here].
+
+For the optional Common Custom User Data Maven extension which is defined the same form, you can see the compatibility of the specified version with the Develocity Maven extension https://github.com/gradle/common-custom-user-data-maven-extension#version-compatibility[here].
+
+For plugin version older that `2.13`, the Maven extension is bundled with the plugin and does not require a version configuration. Please refer to https://github.com/jenkinsci/gradle-plugin/tree/gradle-2.12.1?tab=readme-ov-file#for-maven-builds[this] README version for a compatibility matrix.
 
 == Disabling/uninstalling Gradle Jenkins plugin
 
@@ -537,4 +529,3 @@ From Gradle 0.5, the window launcher is a .bat file that conserves the correct E
 === Release 1.0 (October 04, 2008)
 
 * Initial release
-
diff --git a/images/enable-auto-injection.png b/images/enable-auto-injection.png
diff --git a/images/gradle-settings.png b/images/gradle-settings.png
diff --git a/images/maven-settings.png b/images/maven-settings.png