Comment on page

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​
groupId: org.openrewrite.recipe
artifactId: rewrite-jenkins
version: 0.2.4
Options
Type
Name
Description
String
pluginGroupId
The first part of a dependency coordinate 'io.jenkins.plugins:ARTIFACT_ID:VERSION'.
String
pluginArtifactId
The second part of a dependency coordinate 'GROUP_ID:jackson2-api:VERSION'.
String
pluginVersion
An exact version number.
Set
replaces
The set of library coordinates replaced by this API Plugin.
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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: null
Now that com.yourorg.ReplaceLibrariesWithApiPluginExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-jenkins:0.2.4 in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.ReplaceLibrariesWithApiPluginExample")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-jenkins:0.2.4")
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ReplaceLibrariesWithApiPluginExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-jenkins</artifactId>
            <version>0.2.4</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the 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
See how this recipe works across multiple open-source repositories
​​
​​
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.
Contributors
​Steve Hill, Jonathan Schneider​

Type	Name	Description
`String`	pluginGroupId	The first part of a dependency coordinate 'io.jenkins.plugins:ARTIFACT_ID:VERSION'.
`String`	pluginArtifactId	The second part of a dependency coordinate 'GROUP_ID:jackson2-api:VERSION'.
`String`	pluginVersion	An exact version number.
`Set`	replaces	The set of library coordinates replaced by this API Plugin.

Upgrade property's value to version

Use commons-lang3 API Plugin

Last modified 9d ago