Jenkinsfile

• 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

• 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 specify platforms, jdkVersions and jenkinsVersions (that can not be combined with any of them).

• useArtifactCachingProxy: (default: true) - if set to false, 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 use

    buildPlugin(/*...*/, configurations: [
      [ platform: "linux", jdk: "11", jenkins: null ],
      [ platform: "windows", jdk: "11", jenkins: null ],
      [ platform: "linux", jdk: "17", jenkins: "2.400" ]
    ])

• 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 - If true, skip all the tests by setting the -skipTests profile. It will also skip FindBugs in modern Plugin POMs.

• jacoco: (default: null) - a map of parameters to change the default configuration of the recordCoverage step of the Code Coverage Plugin. This step is called after a plugin build to record the code coverage results of JaCoCo. See recordCoverage step documentation for a list of available configuration parameters.

• pit: (default: null) - a map of parameters to change the default configuration of the recordCoverage step of the Code Coverage Plugin. See recordCoverage step documentation for a list of available configuration parameters. Since running PIT is a time-consuming task, PIT is disabled by default. You need to enable it by setting the property skip to false as well.

• 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 the recordIssues 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 and the recordCoverage steps of the coverage plugin run on the first platform/jdkVersion,jenkinsVersion combination only. So in the example below it will run for linux/jdk11 but not on jdk17.

Usage:

• 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 specify platforms, 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 use

    buildPluginWithGradle(/*...*/, configurations: [
      [ platform: "linux", jdk: "8" ],
      [ platform: "windows", jdk: "8"],
    ])

• tests: (default: null) - a map of parameters to run tests during the build

  • skip - If true, skip all the tests.

• jacoco: (default: null) - a map of parameters to change the default configuration of the recordCoverage step of the Code Coverage Plugin. This step is called after a plugin build to record the code coverage results of JaCoCo. See recordCoverage step documentation for a list of available configuration parameters.

• spotbugs, checkstyle: (default: null) - a map of parameters to archive SpotBugs or CheckStyle warnings, respectively. These values can replace or amend the default configuration for the recordIssues 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.

• noIncrementals: (default: false) - de-activates incremental version publication.

Not all features of buildPlugin() for Maven are supported in the gradle flow. Examples of not supported features:

• Configuring jenkinsVersion for the build flow (as standalone arguments or as configurations)

• Usage of Azure Container Instances as agents (only Maven agents are configured)

Jenkinsfile

Jenkinsfile