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.

Maven Traceability ( traceability ): adds additional output to the maven wrapper script. Maven is executed with parameter --show-version and the start of the wrapper script is indicated by ----- withMaven Wrapper script ----- . Defaults to false .

maven: 'maven-3' 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 a specific settings.xml configuration from Config File Provider Plugin , allowing the replacement of variables and credentials.

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:

Archive and fingerprint generated Maven artifacts and Maven attached artifacts

Publish JUnit / Surefire reports (if the Jenkins JUnit Plugin is installed)

Concordion test reports (since 3.0.0)

And more (see below) …​

The upstream artifact must be generated in a withMaven(){} wrapping step to be detected by the triggering system

The downstream pipeline must have selected the build trigger Build whenever a SNAPSHOT dependency is built

The build trigger can be defined at the pipeline level ( Build Triggers ), at the multibranch pipeline level ( Scan Repository Triggers ) or at the GitHub Organization / Bitbucket Project level ( Scan Organizations Triggers )

You have to manually trigger once the upstream pipeline, and the downstream pipeline so that the link between the pipelines based on the SNAPSHOT dependency is established

The dependency graph is, for the moment, optionally stored in an H2 embedded database ( $JENKINS_HOME/jenkins-jobs/jenkins-jobs.mv.db ). And there is support for PostgreSQL and MySql as well (see details below)

Thresholds are applied to define on which type of maven build the downstream pipelines are triggered

Threshold based on the status of the upstream pipeline ( success , unstable , failure , no build , aborted ). By default, only builds with a success result will trigger downstream builds.

Threshold based on the Maven lifecycle phase reached in the Maven build of the upstream job ( package , install , deploy ). By default, only the maven builds who reach the deploy phase will trigger downstream builds.

Create an empty MySQL database with a dedicated MySQL user with permissions for Data Manipulation Language actions (DML) and Data Definition Language (DDL) actions

Tested with MySQL up to 8.1, with MariaDB up to 11.1 and with Amazon Aurora MySQL 5.6

Install the Jenkins MySQL Database plugin

Navigate to Manage Jenkins / Manage Plugins / Available , select the MySQL Database plugin and click on Download now and install after restart

Configure the Pipeline Maven Plugin to use the created MySQL database

Create Jenkins credentials for the MySQL connection navigating to Credentials on the left menu

Navigate to Manage Jenkins / Global Tools Configuration and go to the Pipeline Maven Configuration

In the Database configuration section, define the following.

JDBC URL: url of the database, e.g. jdbc:mysql://mysql.example.com/jenkins

JDBC Credentials: select the credentials of the MySQL database.

The parameters recommended by the Hikari Connection Pool team are used by default for the MySQL connections and for the datasource (max pool size:10, server side prepared statements cache with 250 entries…​). To overwrite these defaults, click on the Advanced Database Configuration button.

Click on Validate Database Configuration button to verify that the connection is successful.

Click on Save .

Create an empty PostgreSQL database with a dedicated PostgreSQL user with permissions for Data Manipulation Language actions (DML) and Data Definition Language (DDL) actions

Tested with PostgreSQL up to 16

Install the Jenkins the PostgreSQL API plugin

Navigate to Manage Jenkins / Manage Plugins / Available , select the PostgreSQL API plugin and click on Download now and install after restart .

Configure the Pipeline Maven Plugin to use the created PostgreSQL database

Create Jenkins credentials for the PostgreSQL connection navigating to Credentials on the left menu

Navigate to Manage Jenkins / Global Tools Configuration and go to the Pipeline Maven Configuration

In the Database configuration section, define the following

JDBC URL: url of the database, e.g. `jdbc:postgresql://postgresql.example.com:5432/jenkins

JDBC Credentials: select the credentials of the PostgreSQL database

The underlying datasource, HikariCP , comes with sensible default configuration values (see here ). To overwrite these defaults, click on the Advanced Database Configuration button.

Click on Validate Database Configuration button to verify that the connection is successful.

Click on Save .

Navigate to Manage Jenkins / Global Tools Configuration and go to the Pipeline Maven Configuration to verify that the database connection is successful, and the database tables have been created (see screenshot above).