Links
Comment on page

Modernize Jenkinsfile

org.openrewrite.jenkins.ModernizeJenkinsfile
Updates Jenkinsfile to build with recommended Java versions, platforms, and settings.

Recipe source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-jenkins
  • version: 0.2.4

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-jenkins:0.2.4 in your build file or by running a shell command (in which case no build changes are needed):
Gradle
Gradle init script
Maven POM
Maven Command Line
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("org.openrewrite.jenkins.ModernizeJenkinsfile")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-jenkins:0.2.4")
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Create a file named init.gradle in the root of your project.
init.gradle
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.5.6") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-jenkins:0.2.4")
}
rewrite {
activeRecipe("org.openrewrite.jenkins.ModernizeJenkinsfile")
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
  1. 2.
    Run gradle --init-script init.gradle rewriteRun to run the recipe.
  1. 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>org.openrewrite.jenkins.ModernizeJenkinsfile</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>
  1. 2.
    Run mvn rewrite:run to run the recipe.
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-jenkins:RELEASE \
-Drewrite.activeRecipes=org.openrewrite.jenkins.ModernizeJenkinsfile
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ModernizeJenkinsfile

Definition

Recipe List
Yaml Recipe List
    • fileContents: /* See the documentation for more options: https://github.com/jenkins-infra/pipeline-library/ */ buildPlugin( useContainerAgent: true, // Set to falseif you need to use Docker for containerized tests configurations: [ [platform: 'linux', jdk: 21], [platform: 'windows', jdk: 17], ])
    • relativeFileName: Jenkinsfile
    • overwriteExisting: true
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.jenkins.ModernizeJenkinsfile
displayName: Modernize Jenkinsfile
description: Updates `Jenkinsfile` to build with recommended Java versions, platforms, and settings.
recipeList:
- org.openrewrite.text.CreateTextFile:
fileContents: /*
See the documentation for more options:
https://github.com/jenkins-infra/pipeline-library/
*/ buildPlugin(
useContainerAgent: true, // Set to `false` if you need to use Docker for containerized tests
configurations: [
[platform: 'linux', jdk: 21],
[platform: 'windows', jdk: 17],
])
relativeFileName: Jenkinsfile
overwriteExisting: true

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.