Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 63 Next »

Plugin Information

View Pipeline Maven Integration on the plugin site for more information.

Older versions of this plugin may not be safe to use. Please review the following warnings before using an older version:



Provides Maven integration with Pipeline Plugin by using the withMaven step, which configures a maven environment to use within a pipeline job by calling sh mvn or bat mvn.


An example pipeline script using the pipeline Maven plugin:

Maven build on a Linux agent
  stage ('Build') {

    git url: 'https://github.com/cyrille-leclerc/multi-module-maven-project'

        // Maven installation declared in the Jenkins "Global Tool Configuration"
        maven: 'M3',
        // Maven settings.xml file defined with the Jenkins Config File Provider Plugin
        // Maven settings and global settings can also be defined in Jenkins Global Tools Configuration
        mavenSettingsConfig: 'my-maven-settings',
        mavenLocalRepo: '.repository') {

      // Run the maven build
      sh "mvn clean install"

    } // withMaven will discover the generated Maven artifacts, JUnit Surefire & FailSafe reports and FindBugs reports

Withn a node or a docker.image block, create a withMaven block to setup a with maven environment. The configured environment will be used when calling maven inside the block by using sh mvn or bat mvn. The following parameters can be used to configure maven:

  • Maven (maven): Allow the selection of a Maven installation configured on the Global Jenkins configuration or on the Global Tool Configuration page if using Jenkins > 2.0. When auto-install is enabled, maven will be downloaded and made available for the pipeline job.
  • JDK (jdk): Allows the selection of a JDK installation. If auto-install is enabled, the JDK will be downloaded and made available for the pipeline job.
  • Maven Settings
    • Maven Settings Config (mavenSettingsConfig): Select a Maven settings file ID from Config File Provider Plugin allowing the replacement of server credentials and variable substitutions as configured in Config File Provider Plugin. The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. See also settings.xml reference
    • Maven Settings File Path (mavenSettingsFilePath): Specify the path to a Maven settings.xml file on the build agent. The specified path can be absolute or relative to the workspace. 

    • If none of "mavenSettingsConfig" and "mavenSettingsFilePath" are defined, "withMaven(){}" will use the Maven settings defined in the Jenkins Global Tool Configuration if declared

  • Maven Global Settings

    • Maven Global Settings Config (globalMavenSettingsConfig): Select a Maven global settings file ID from Config File Provider Plugin.

    • Maven Global Settings File Path (globalMavenSettingsFilePath): Specify the path to a Maven global settings.xml file on the build agent. The specified path can be absolute or relative to the workspace.

    • If none of "globalMavenSettingsConfig" and "globalMavenSettingsFilePath" are defined, "withMaven(){}" will use the Maven global settings defined in the Jenkins Global Tool Configuration if declared

  • Maven JVM Opts (mavenOpts): Specify JVM specific options needed when launching Maven as an external process, these are not maven specific options. See: Java Options
    Shell-like environment variable expansions work in this field, by using the ${VARIABLE} syntax.
  • Maven Local Repository (mavenLocalRepo): Specify a custom local repository path. Shell-like environment variable expansions work with this field, by using the ${VARIABLE} syntax. Normally, Jenkins uses the local Maven repository as determined by Maven, by default ~/.m2/repository and can be overridden by <localRepository> in ~/.m2/settings.xml (see Configuring your Local Repository))
    This normally means that all the jobs that are executed on the same node shares a single Maven repository. The upside of this is that you can save the disk space, the downside is that the repository is not multi process safe and having multiple builds run concurrently can corrupt it. Additionally builds could interfere with each other by sharing incorrect or partially built artifacts. For example, you might end up having builds incorrectly succeed, just because your have all the dependencies in your local repository, despite that fact that none of the repositories in POM might have them.
    By using this option, Jenkins will tell Maven to use a custom path for the build as the local Maven repository by using -Dmaven.repo.local
    If specified as a relative path then this value will be resolved against the workspace root and not the current working directory.
    ie. $WORKSPACE/.repository if .repository value is specified.

(info) mavenSettingsConfig and globalMavenSettingsConfig use the ID, not the name, of the Maven settings file (resp Maven Global Settings file).

The Pipeline Syntax snippet code generator can be used to assist on generating the withMaven step parameters

In the above example the following parameters are use to configure maven:

  • maven: 'M3' Maven Installation will be used, this installation has to be declared in the Global Jenkins configuration or Tool installations page.
  • mavenLocalRepo: a local repository folder is specified to avoid shared repositories
  • mavenSettingsConfig: specifies an specific settings.xml configuration from Config File Provider Plugin plugin, allowing the replacement of variables and credentials.


Sensible default Maven parameters

The Maven parameters that are useful on a build server, "--batch-mode" ("-B") and "--show-version" ("-V") are enable by default, no need to add them in your mvn invocations.

Maven Settings Support

The "withMaven()" pipeline step will setup the Maven settings file and global settings file either explicitly using the attributes of the "withMaven(){}" step declaration or implicitly using the Maven Global Settings and Settings files defined in the Jenkins Global Tools Configuration.

Using implicit declaration, Jenkins administrators can simplify the work of pipeline authors hiding the "boilerplate" to declare the credentials of the Git, Nexus, Artifactory... servers and all the needed proxies, mirrors...

Traceability of Maven builds

The "withMaven()" pipeline step will capture in the logs of the build all the details of the execution:

  • Version of the JVM
    • "withMaven(){}" step initialization: "[withMaven] use JDK installation JDK8"
    • "mvn" executable invocation: "Java version: 1.8.0_102, vendor: Oracle Corporation""
  • Version of Maven
    • "withMaven(){}" step initialization: "[withMaven] use Maven installation 'M3'""
    • "mvn" executable invocation: "Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00)""
  • Name or path of the Maven settings.xml and Maven global settings.xml file.
    • "withMaven(){}" step initialization: "[withMaven] use Maven settings provided by the Jenkins Managed Configuration File 'maven-settings-for-supply-chain-build-job'"
  • When using the Maven settings.xml and global settings.xml files provided by the Jenkins Config File Provider Plugin,
    details of the Jenkins credentials injected in the Maven build.
    • "withMaven(){}" step initialization: "[withMaven] use Maven settings.xml 'maven-settings-for-supply-chain-build-job' with Maven servers credentials provided by Jenkins (replaceAll: true): [mavenServerId: 'nexus.beescloud.com', jenkinsCredentials: 'beescloud-nexus-deployment-credentials', username: 'deployment', ...]"


[withMaven] use JDK installation JDK8
[withMaven] use Maven installation 'M3'
[withMaven] use Maven settings provided by the Jenkins Managed Configuration File 'maven-settings-for-supply-chain-build-job'
[withMaven] use Maven settings.xml 'maven-settings-for-supply-chain-build-job' with Maven servers credentials provided by Jenkins (replaceAll: true):
     [mavenServerId: 'nexus.beescloud.com', jenkinsCredentials: 'beescloud-nexus-deployment-credentials', username: 'deployment', type: 'UsernamePasswordCredentialsImpl'],
     [mavenServerId: 'github.beescloud.com', jenkinsCredentials: 'github-enterprise-api-token', username: 'dev1', type: 'UsernamePasswordCredentialsImpl']
Running shell script
+ mvn clean deploy
----- withMaven Wrapper script -----
Picked up JAVA_TOOL_OPTIONS: -Dmaven.ext.class.path=".../pipeline-maven-spy.jar" -Dorg.jenkinsci.plugins.pipeline.maven.reportsFolder="..."
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00)
Maven home: /home/ubuntu/jenkins-home/tools/hudson.tasks.Maven_MavenInstallation/M3
Java version: 1.8.0_102, vendor: Oracle Corporation
Java home: /home/ubuntu/jenkins-home/tools/hudson.model.JDK/JDK8/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "3.13.0-109-generic", arch: "amd64", family: "unix"

Maven Build Phases Publishers

Maven build executions inside the "withMaven(){...}" will be detected and Jenkins will transparently

(info) The detection of Maven builds require to use Maven 3.2+.



Required Jenkins Plugin (1)

Configuration to disable the feature

Since v2.3.0 (2)

Marker file to disable the feature (3)

Generated Artifact

Archiving and the fingerprinting of the artifacts and attached artifacts generated by the Maven build (jar, sources jar, javadocs jar...)


withMaven(options: [artifactsPublisher(disabled: true)],...)


Generated JUnit, Surefire and FailSafe reports

Publishing of the JUnit, Surefire and FailSafe reports generated by the Maven build

JUnit Plugin

withMaven(options: [junitPublisher(disabled: true)],...)


Generated Findbugs reports

Publishing of the Findbugs reports generated by the Maven build

FindBugs Plugin

withMaven(options: [findbugsPublisher(disabled: true)],...)


Tasks scanner report

Publishing of a report of the "FIXME" and "TODO" tasks found in the java source code. The keywords can be configured.

Jenkins Tasks Scanner Plugin

withMaven(options: [openTasksPublisher(disabled: true)],...)


Dependencies Fingerprinting

(since 2.5.0)

Fingerprint the Maven dependencies.

By default only the snapshot dependencies of scope compile, runtime and provided are fingerprinted.

 withMaven(options: [dependenciesFingerprintPublisher(disabled: true)],...)`.skip-fingerprint-maven-dependencies`

(1) Jenkins Plugin to publish the reports on the Jenkins build page. If the plugin is not installed, then the MAven report is ignored.

(2) Download pipeline-maven-2.3.0-beta-1.hpi

(3) Experimental feature.
Marker file to temporarily disable the feature for a specific Maven build.
Typically used to disable a reporter for a specific build that would generate too much data for the default configuration of the reporter (e.g. too many generated artifacts...) or to workaround a bug in the "withMaven" waiting for a fix. These marker file must be located in the home directory of the build.

Global Default Configuration

The default configuration of the Maven settings, global settings and the publishers can be defined in the "Global Tool Configuration" screen.

Linux, Windows and MacOSX support

The Pipeline Maven Plugin works with Linux, Windows and MacOSX build agents.

Maven build on a Windows agent
node ("windows") {
  stage ('Build') {

    git url: 'https://github.com/cyrille-leclerc/multi-module-maven-project'

    withMaven(...) {

      bat "mvn clean install"

    } // withMaven will discover the generated Maven artifacts, JUnit Surefire & FailSafe reports and FindBugs reports

Adding more Maven Reporters

The API for Maven reporters is still experimental. Please open a Request for Enhancement Jira issue to discuss how to add Maven reporters.

We want to quickly add reporters for CheckStyle, Jacoco...


How to disable the Maven Event Spy injected by the Pipeline Maven Plugin in Maven builds?

It may be convenient to temporarily disable the Maven Event Spy of the Jenkins Pipeline Maven plugin, for example for troubleshooting purpose.

You can disable the Maven Event Spy of the Jenkins Pipeline Maven plugin (making it no-op) doing one of the following:

  • Setting the environment variable "JENKINS_MAVEN_AGENT_DISABLED" to "true" in the job execution


   sh """
mvn package
   sh "mvn package"


  • Adding the system property "-Dorg.jenkinsci.plugins.pipeline.maven.eventspy.JenkinsMavenEventSpy.disabled=true" to the invocation of the mvn build

Why do I see messages "[WARNING] Picked up JAVA_TOOL_OPTIONS..." in the build logs?

The Jenkins Pipeline Maven Plugin uses the "JAVA_TOOL_OPTIONS" environment variable to pass options to subsequent Maven builds such as the actual release build when invoking "mvn release:prepare release:perform". The plugins passes the properties "-Dmaven.ext.class.path" and "-Dorg.jenkinsci.plugins.pipeline.maven.reportsFolder".

When using the "JAVA_TOOL_OPTIONS", the JVM outputs a message during its initialization.

With the Jenkins Pipeline Maven Plugin, this message looks like:

[WARNING] Picked up JAVA_TOOL_OPTIONS: -Dmaven.ext.class.path="/path/to/workspace/...@tmp/withMaven.../pipeline-maven-spy.jar" -Dorg.jenkinsci.plugins.pipeline.maven.reportsFolder="/path/to/workspace/...@tmp"

How do I capture the log file generated by the Jenkins Maven Event Spy

You can archive the XML log file generated by the Jenkins Maven Event Spy creating the marker file ".archive-jenkins-maven-event-spy-logs".


withMaven() {
	sh "mvn package"
	writeFile file: '.archive-jenkins-maven-event-spy-logs', text: ''
} // will discover the marker file ".archive-jenkins-maven-event-spy-log" and will archive the maven event spy log file maven-spy-....log	

How do I check the Maven settings in use by my build

You can dump the effective Maven settings of your pipeline using the Maven Help plugin and the "help:effective-settings" goal

   mvn help:effective-settings

Known Limitations

Maven and JDK installers do not work with "docker.image('xxx').inside{...}" as the docker step does not allow the use of Tool Installer, the preinstalled Maven and JDK on the docker image will be auto-discovered and used.



  • JENKINS-45221 Use case insensitive path when computing the workspace relative path


  • JENKINS-45024 Use org.eclipse.aether.artifact.Artifact#isSnapshot() to identify snapshot versions

  • JENKINS-40484 Better troubleshooting messages


  • JENKINS-43094 Support Fingerprinting of consumed dependencies

  • JENKINS-44807 Generated artifacts are only fingerprinted as fingerprint.original but not as fingerprint.usage


  • JENKINS-44226 Support junit testDataPublishers
    • Publishing of junit test attachments are enabled by default if the junit-attachments-plugin is installed.
    • Junit test attachments can be disabled using options: [junitPublisher(ignoreAttachments: true)]. Sample:


junitPublisher ignore attachments sample
        mavenSettingsConfig: 'my-maven-settings',
        options: [junitPublisher(ignoreAttachments: true)]) {
    sh "mvn clean install"
  • JENKINS-44386 Add configuration options to the OpenTasksPublisher
    • Sample
openTasksPublisher options sample
       pattern:'src/main/java', excludePattern:'src/main/java/excluded',
       ignoreCase:true, asRegexp:false, 
       lowPriorityTaskIdentifiers:'minor', normalPriorityTaskIdentifiers:'todo', highPriorityTaskIdentifiers:'fixme')]) {

           sh 'mvn package verify'




  • Add configuration options to disable the publishers. Code look like:
Options to disable publishers
    options: [
	  findbugsPublisher(disabled: true), 
	  artifactsPublisher(disabled: true), 
	  junitPublisher(disabled: true), 
	  openTasksPublisher(disabled: true)]) {
   sh "mvn clean deploy"



  •  JENKINS-44088 Fix bug when Windows agent use the "/" file separator instead of the "\" file separator



  • JENKINS-39407 - Use Maven Global Settings and Maven Settings defined at the Jenkins global level if not specified in the pipeline withMaven(){...} step


  • JENKINS-43714 - withMaven thinks that "mvn test" generates a jar file causing a FileNotFoundException trying to archive it 

  • JENKINS-43678 - Exception archiving and fingerprinting Maven artifact

  • JENKINS-43616 - Flattened pom throws errors


  • JENKINS-43261 - Bug - withMaven parses emtpy EventSpy logfiles
  • JENKINS-43529 - Bug - Disabled Jenkins Maven Event Spy generates an invalid XML build log file

  • JENKINS-43491 - Enhancement - Feature flag to archive the Maven build logs for troubleshooting purpose (marker file ".archive-jenkins-maven-event-spy-logs")



  • Detect Maven build details and process the outputs of the build:
  • More detailed traceability of the Maven settings used for the build


  • High severity security release, please read advisory for SECURITY-309. If you are running 2.0-beta you should update at least to 2.0-beta-6


  • Wrong release, no changes over the previous.


  • JENKINS-39916 upgrade to config-file-provider:2.15.1 and support definition of Maven settings file and global settings file at the folder level


  • JENKINS-39134 -  Fix exception after resuming a build
  • Allow defining global Maven settings by config file (globalMavenSettingsConfig) and by file path (globalMavenSettingsFilePath)
  • JENKINS-40142 - Snippet generator was creating parameters even if they were left empty


  • JENKINS-38709 - Console log filter was being overriden, which didn't allow the use of other steps which filtered the logs (ie. MaskPasswordBuildWrapper, AnsiColorBuildWrapper, etc.)
  • MAVEN_TERMINATE_CMS is no longer overriden. Setting MAVEN_TERMINATE_CMS to "on" causes Windows batch execution to be completed after the first call to mvn, as mvn will use exit instead of exit /b


  • First stable release
  • JENKINS-37613 - Unify naming convention for tool installation. The mavenInstallation parameter was renamed to maven.


  • Initial version
  • No labels