Skip to main content

Use Jenkins API plugin instead of libraries

org.openrewrite.jenkins.ReplaceLibrariesWithApiPlugin

Prefer Jenkins API plugins over bundling libraries for slimmer plugins.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringpluginGroupIdThe first part of a dependency coordinate 'io.jenkins.plugins:ARTIFACT_ID:VERSION'.io.jenkins.plugins
StringpluginArtifactIdThe second part of a dependency coordinate 'GROUP_ID:jackson2-api:VERSION'.jackson2-api
StringpluginVersionAn exact version number.1981.v17df70e84a_a_1
SetreplacesThe set of library coordinates replaced by this API Plugin.
groupId: org.apache.commons
artifactId: commons-text

Example​

Parameters​
ParameterValue
pluginGroupIdio.jenkins.plugins
pluginArtifactIdcommons-text-api
pluginVersion1.9-5.v7ea_44fe6061c
replacesSet.of(new ReplaceLibrariesWithApiPlugin.Library("org.apache.commons", "commons-text"))
Before​
pom.xml
<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>repo.jenkins-ci.org</id>
            <url>https://repo.jenkins-ci.org/public/</url>
        </repository>
    </repositories>
</project>
After​
pom.xml
<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>repo.jenkins-ci.org</id>
            <url>https://repo.jenkins-ci.org/public/</url>
        </repository>
    </repositories>
</project>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ReplaceLibrariesWithApiPluginExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ReplaceLibrariesWithApiPluginExample
displayName: Use Jenkins API plugin instead of libraries example
recipeList:
  - org.openrewrite.jenkins.ReplaceLibrariesWithApiPlugin:
      pluginGroupId: io.jenkins.plugins
      pluginArtifactId: jackson2-api
      pluginVersion: 1981.v17df70e84a_a_1
      replaces: groupId: org.apache.commons
artifactId: commons-text

Now that com.yourorg.ReplaceLibrariesWithApiPluginExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-jenkins:0.25.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

rewrite {
    activeRecipe("com.yourorg.ReplaceLibrariesWithApiPluginExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-jenkins:0.25.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Steve Hill, Jonathan Schneider, Tim te Beek