Open source

Use Jenkins API plugin instead of libraries

Recipe IDorg.openrewrite.jenkins.ReplaceLibrariesWithApiPlugin

Artifactorg.openrewrite.recipe:rewrite-jenkins

Prefer Jenkins API plugins over bundling libraries for slimmer plugins.

Single recipeOpenRewriteModerne Source Available License

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

4 parameters

4 required

Parameter	Example	Type	Required
pluginArtifactId	jackson2-api	String	Required
The second part of a dependency coordinate 'GROUP_ID:jackson2-api:VERSION'.
pluginGroupId	io.jenkins.plugins	String	Required
The first part of a dependency coordinate 'io.jenkins.plugins:ARTIFACT_ID:VERSION'.
pluginVersion	1981.v17df70e84a_a_1	String	Required
An exact version number.
replaces	groupId: org.apache.commons artifactId: commons-text	Set	Required
The set of library coordinates replaced by this API Plugin.

Examples

xml

Parameter	Value
pluginGroupId	io.jenkins.plugins
pluginArtifactId	commons-text-api
pluginVersion	1.9-5.v7ea_44fe6061c
replaces	Set.of(new ReplaceLibrariesWithApiPlugin.Library("org.apache.commons", "commons-text"))

xml

Before

<project>
    <parent>
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
        <version>4.86</version>
        <relativePath />
    </parent>
    <artifactId>foo</artifactId>

    <properties>
        <jenkins.version>2.440.3</jenkins.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.turbine</groupId>
            <artifactId>turbine</artifactId>
            <version>5.1</version>
        </dependency>
    </dependencies>

    <repositories>
        <repository>
            <id>maven-central</id>
            <url>https://repo1.maven.org/maven2/</url>
        </repository>
        <repository>
            <id>repo.jenkins-ci.org</id>
            <url>https://repo.jenkins-ci.org/public/</url>
        </repository>
    </repositories>
</project>

After

<project>
    <parent>
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
        <version>4.86</version>
        <relativePath />
    </parent>
    <artifactId>foo</artifactId>

    <properties>
        <jenkins.version>2.440.3</jenkins.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>io.jenkins.plugins</groupId>
            <artifactId>commons-text-api</artifactId>
            <version>1.9-5.v7ea_44fe6061c</version>
        </dependency>
        <dependency>
            <groupId>org.apache.turbine</groupId>
            <artifactId>turbine</artifactId>
            <version>5.1</version>
            <exclusions>
                <exclusion>
                    <!-- brought in by io.jenkins.plugins:commons-text-api -->
                    <groupId>org.apache.commons</groupId>
                    <artifactId>commons-text</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <repositories>
        <repository>
            <id>maven-central</id>
            <url>https://repo1.maven.org/maven2/</url>
        </repository>
        <repository>
            <id>repo.jenkins-ci.org</id>
            <url>https://repo.jenkins-ci.org/public/</url>
        </repository>
    </repositories>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -16,0 +16,5 @@
    <dependencies>
        <dependency>
+           <groupId>io.jenkins.plugins</groupId>
+           <artifactId>commons-text-api</artifactId>
+           <version>1.9-5.v7ea_44fe6061c</version>
+       </dependency>
+       <dependency>
            <groupId>org.apache.turbine</groupId>
@@ -19,0 +24,7 @@
            <artifactId>turbine</artifactId>
            <version>5.1</version>
+           <exclusions>
+               <exclusion>
+                   <!-- brought in by io.jenkins.plugins:commons-text-api -->
+                   <groupId>org.apache.commons</groupId>
+                   <artifactId>commons-text</artifactId>
+               </exclusion>
+           </exclusions>
        </dependency>

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 ReplaceLibrariesWithApiPlugin --recipe-option "pluginGroupId=io.jenkins.plugins" --recipe-option "pluginArtifactId=jackson2-api" --recipe-option "pluginVersion=1981.v17df70e84a_a_1" --recipe-option "replaces=groupId: org.apache.commons
artifactId: commons-text"

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

mod config recipes jar install org.openrewrite.recipe:rewrite-jenkins:0.36.1

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.