This repository contains a series of steps and variables for use inside of the Jenkins project’s own Jenkins instance(s).
Check this description of available services.
Warning
|
Gradle support in buildPlugin() is deprecated and will be eventually removed. Please use buildPluginWithGradle()
|
Applies the appropriate defaults for building a Maven-based plugin project on Linux and Windows.
You are advised to be using a 2.x or newer parent POM.
buildPlugin(
useContainerAgent: true,
configurations: [
[platform: 'linux', jdk: 11],
[platform: 'linux', jdk: 17],
[platform: 'windows', jdk: 11],
])
-
repo
(default:null
inherit from Multibranch) - custom Git repository to check out -
useContainerAgent
(default:false
) - uses a Container agent instead of a Virtual Machine: usually faster to start and generates less costs for the project-
Please note that the implementation of "containers" can be changed over time
-
-
useAci
(DEPRECATED - seeuseContainerAgent
) -
failFast
(default:true
) - instruct Maven tests to fail fast -
platforms
(default:['linux', 'windows']
) - Labels matching platforms to execute the steps against in parallel -
jdkVersions
(default:[8]
) - JDK version numbers, must match a version number jdk tool installed -
jenkinsVersions
: (default:[null]
) - a matrix of Jenkins baseline versions to build/test against in parallel (null means default, only available for Maven projects) -
configurations
: An alternative way to specifyplatforms
,jdkVersions
andjenkinsVersions
(that can not be combined with any of them). -
useArtifactCachingProxy
: (default:true
) - if set tofalse
, artifacts will not use one of the artifact caching proxy depending on the agent provider (Azure, DigitalOcean or AWS), and will directly use repo.jenkins-ci.org instead (discouraged as less reliable and consuming bandwidth)-
Those options will run the build for all combinations of their values. While that is desirable in many cases,
configurations
permit to provide a specific combinations of label and java/jenkins versions to usebuildPlugin(/*...*/, configurations: [ [ platform: "linux", jdk: "8", jenkins: null ], [ platform: "windows", jdk: "8", jenkins: null ], [ platform: "linux", jdk: "11", jenkins: "2.150" ] ])
-
-
tests
: (default:null
) - a map of parameters to run tests during the build. The test results and the JaCoCo code coverage results are recorded after the build with the corresponding Jenkins plugins.-
skip
- Iftrue
, skip all the tests by setting the-skipTests
profile. It will also skip FindBugs in modern Plugin POMs.
-
-
spotbugs
,checkstyle
,pmd
,cpd
: (default:null
) - a map of parameters to archive SpotBugs, CheckStyle, PMD, or CPD warnings, respectively (only available for Maven projects). These values can replace or amend the default configuration for therecordIssues
step of the Warnings NG Plugin. See Warnings NG Plugin documentation for a list of available configuration parameters. -
timeout
: (default:60
) - the number of minutes for build timeout, cannot be bigger than 180, i.e. 3 hours.
Note
|
The recordIssues steps of the warnings plugin run on the first platform/jdkVersion,jenkinsVersion combination only.
So in the example below it will run for linux /jdk7 but not on jdk8 .
|
Usage:
buildPlugin(platforms: ['linux'],
jdkVersions: [7, 8],
checkstyle: [qualityGates: [[threshold: 1, type: 'NEW', unstable: true]]],
pmd: [trendChartType: 'TOOLS_ONLY', qualityGates: [[threshold: 1, type: 'NEW', unstable: true]]])
Builds a Jenkins plugin using Gradle. The implementation follows the standard build/test/archive pattern. The method targets compatibility with Gradle JPI Plugin, and it may not work for other use-cases.
-
repo
(default:null
inherit from Multibranch) - custom Git repository to check out -
failFast
(default:true
) - instruct the build to fail fast when one of the configurations fail -
platforms
(default:['linux', 'windows']
) - Labels matching platforms to execute the steps against in parallel -
jdkVersions
(default:[8]
) - JDK version numbers, must match a version number jdk tool installed -
configurations
: An alternative way to specifyplatforms
,jdkVersions
(that can not be combined with any of them)-
Those options will run the build for all combinations of their values. While that is desirable in many cases,
configurations
permit to provide a specific combinations of label and java/jenkins versions to usebuildPluginWithGradle(/*...*/, configurations: [ [ platform: "linux", jdk: "8" ], [ platform: "windows", jdk: "8"], ])
-
-
tests
: (default:null
) - a map of parameters to run tests during the build-
skip
- Iftrue
, skip all the tests.
-
-
timeout
: (default:60
) - the number of minutes for build timeout, cannot be bigger than 180, i.e. 3 hours.
Not all features of buildPlugin()
for Maven are supported in the gradle flow.
Examples of not supported features:
-
Deployment of incremental versions (JEP-305)
-
Publishing of static analysis and coverage reports (Checkstyle, SpotBugs, JaCoCo)
-
Configuring
jenkinsVersion
for the build flow (as standalone arguments or asconfigurations
) -
Usage of Azure Container Instances as agents (only Maven agents are configured)
Determine whether the Pipeline is executing in an internal "trusted" Jenkins environment
if (infra.isTrusted()) {
/* perform some trusted action like a deployment */
}
Ensures that the given code block is runs in a node with the specified labels
infra.ensureInNode('docker,java') {
sh 'docker -v'
}
Runs JMH benchmarks and archives benchmark reports on highmem
nodes.
Supported parameters:
artifacts
-
(Optional) If
artifacts
is not null, invokesarchiveArtifacts
with the given string value.
Lints, Builds, then publishes a docker image.
Adds a bunch of build args you can use in your docker image:
-
GIT_COMMIT_REV - The commit that triggered this build
-
GIT_SCM_URL - Url to repo
-
BUILD_DATE - Date that the image was built (now)
Supported parameters:
imageName
-
Name of the docker image to build
configs
-
(Optional) extra flags
registry: override the smart default of jenkinsciinfra/ or jenkins4eval/ dockerfile: override the default dockerfile of Dockerfile