Moderne licensed

Use Jenkins API plugin instead of libraries

Recipe IDorg.openrewrite.jenkins.ReplaceLibrariesWithApiPluginArtifactorg.openrewrite.recipe:rewrite-jenkins

Prefer Jenkins API plugins over bundling libraries for slimmer plugins.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.jenkins.ReplaceLibrariesWithApiPlugin")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-jenkins:0.38.1")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.jenkins.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 isn’t available locally, install it with:

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

Options

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

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats