Simple Maven build on a Linux agent.

More complex Maven build on a Windows agent.

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.

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 at the folder level or 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…​

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:

• mvn executable invocation:

• Version of Maven

  • withMaven(){} step initialization:

• mvn executable invocation:

• Name or path of the Maven settings.xml and Maven global settings.xml file.

  • withMaven(){} step initialization:

• 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:

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

• 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) …​

⚠️	Deprecated publishers Publish Findbugs reports (if the Jenkins FindBugs Plugin is installed) Publish a report of the tasks (FIXME and TODO) found in the java source code (if the Jenkins Tasks Scanner Plugin is installed).

💡	In the future, deprecated publishers should be replaced by Warnings Next Generation implementations (See: JENKINS-57427)

ℹ️	The detection of Maven builds requires using Maven 3.2+.

   <plugin>
        <groupId>com.github.eirslett</groupId>
        <artifactId>frontend-maven-plugin</artifactId>
        <executions>
            <execution>
                ...
                <configuration>
                    ...
                    <environmentVariables>
                        <REPORTS_DIRECTORY>${project.build.directory}/karma-reports</REPORTS_DIRECTORY>
                    </environmentVariables>
                </configuration>
            </execution>
        </executions>
    </plugin>

(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) 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 markers file must be located in the home directory of the build.

Default Maven settings can be defined globally and at the folder level.

ℹ️	Available since version 3.0.0

Trigger downstream pipeline that depend on Maven artifact generated by upstream pipelines.

ℹ️

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, exclusively stored in an H2 embedded database ($JENKINS_HOME/jenkins-jobs/jenkins-jobs.mv.db). Support for an external H2 database and then for alternate databases (PostgreSQL) is on the roadmap (see PipelineMavenPluginH2Dao.java)

• 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.

ℹ️	Available since version 3.0.3

The Pipeline Maven Plugin works with Takari’s Maven wrapper 'mvnw'.

ℹ️	Available since version 3.6.0

The Jenkins Pipeline Maven Plugin relies on a database to store its data (list of dependencies and of generated artifacts of each build…​).

By default, the Jenkins Pipeline Maven Plugin uses an H2 embedded database, but it is recommend to use an external MySQL database.

Configuration steps to use a MySQL:

• 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 8.0, with MariaDB 10.2 and 10.3 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.

ℹ️	Available since version 3.7.0

The Jenkins Pipeline Maven Plugin relies on a database to store its data (list of dependencies and of generated artifacts of each build…​).

By default, the Jenkins Pipeline Maven Plugin uses an H2 embedded database, but it is recommended to use an external PostgreSQL or MySQL / MariaDB database.

Configuration steps to use a PostgreSQL:

• 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 10.6 and 11.3

• 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).

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.

withMaven() not supported in docker.image('xxx').inside{…​} with old versions of the Docker engine such as Docker 1.13.1 on CentOS7.

Any help to fix this bug is more than welcome.

JENKINS-40484 - Getting issue details…​ STATUS