Open source

Add the Develocity Maven extension

Recipe IDorg.openrewrite.maven.AddDevelocityMavenExtension

Artifactorg.openrewrite:rewrite-maven

To integrate the Develocity Maven extension into Maven projects, ensure that the develocity-maven-extension is added to the .mvn/extensions.xml file if not already present. Additionally, configure the extension by adding the .mvn/develocity.xml configuration file.

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

6 parameters

1 required5 optional

Parameter	Example	Type	Required
server	https://scans.gradle.com/	String	Required
The URL of the Develocity server.
allowUntrustedServer	true	Boolean	Optional
When set to true the extension will be configured to allow unencrypted http connections with the server. If set to false or omitted, the extension will refuse to communicate without transport layer security enabled.
fileFingerprints	true	Boolean	Optional
When set to true the extension will capture additional information about the inputs to Maven goals. This increases the size of build scans, but is useful for diagnosing issues with goal caching.
publishCriteria	Always	PublishCriteria	Optional
When set to Always the extension will publish build scans of every single build. This is the default behavior when omitted.When set to Failure the extension will only publish build scans when the build fails. When set to Demand the extension will only publish build scans when explicitly requested.
uploadInBackground	false	Boolean	Optional
When set to false the extension will not upload build scan in the background. By default, build scans are uploaded in the background after the build has finished to avoid blocking the build process.
version	1.17.4	String	Optional
A maven-compatible version number to select the gradle-enterprise-maven-extension version.

Examples

xml, xml

Parameter	Value
version	1.17
server	https://foo
allowUntrustedServer	null
fileFingerprints	null
uploadInBackground	null
publishCriteria	null

Unchanged

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
</project>

xml

New file

<gradleEnterprise>
  <server>
    <url>https://foo</url>
  </server>
</gradleEnterprise>

xml

Before

<?xml version="1.0" encoding="UTF-8"?>
<extensions>
</extensions>

After

<?xml version="1.0" encoding="UTF-8"?>
<extensions>
  <extension>
    <groupId>com.gradle</groupId>
    <artifactId>gradle-enterprise-maven-extension</artifactId>
    <version>1.17</version>
  </extension>
</extensions>

Diff

--- .mvn/extensions.xml
+++ .mvn/extensions.xml
@@ -3,0 +3,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<extensions>
+ <extension>
+   <groupId>com.gradle</groupId>
+   <artifactId>gradle-enterprise-maven-extension</artifactId>
+   <version>1.17</version>
+ </extension>
</extensions>

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe AddDevelocityMavenExtension --recipe-option "version=1.17.4" --recipe-option "server=https://scans.gradle.com/" --recipe-option "allowUntrustedServer=true" --recipe-option "fileFingerprints=true" --recipe-option "uploadInBackground=false" --recipe-option "publishCriteria=Always"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-maven:8.85.6

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.