TeamCity 7.0 Help

Maven

Note that you can create new Maven-based build configuration Creating and Editing Build Configurations, and set up a Configuring Maven Triggers, if specific Maven artifact has changed.

Below you can find reference information about the Maven2 Build Runner fields:

Maven Parameters

Option

Description

Goals

In the Goals field, specify the sequence of space-separated Maven goals that you want TeamCity to execute. Some Maven goals can use version control systems, and, thus, they may become incompatible with some Configuring VCS Settings. If you want TeamCity to execute such goal:

  • Select "Automatically on agent" in the VCS checkout mode drop-down list on the Version Control Settings page. This makes the version control system available to a goal execution software.

Path to a POM file

Specify path to the POM file relative to the Build Working Directory. By default, the property contains a pom.xml file. If you leave this field blank, the same value is put in this field. The path may also point to a subdirectory, and as such <subdirectory>/pom.xml is used.

Additional Maven command line parameters

Specify the list of command line parameters.

Working directory

Specify the Build working directory, if it differs from the Build Checkout Directory.

Maven Home

In Maven selection field choose Maven version you want to use. By default the path to Maven installation is taken from the M2_HOME environment variable, otherwise the bundled Maven 3 is used. Alternatively, you can set it as %\MAVEN_HOME% environment variable right on a build agent.

User Settings

Specify what kind of user settings to use here. This is equivalent to Maven command line option -s or --settings. The available options are:

Default

Settings are taken from the default location (chosen by Maven).

User settings path

Enter the path to an alternative user settings file.

Predefined settings

If there are settings filed uploaded to TeamCity server you can select here, which of those files to use. To upload a user settings file to TeamCity, click Manage settings files. You can upload Maven user settings files at any time at Administration | Maven Settings tab. The uploaded files are stored under < >/config/_mavenSettings directory. If necessary, they can be edited right there.

Java Parameters

JDK Home Path

The path to JDK Home is read from the *JAVA_HOME* environment variable or *JDK home* specified on the build agent if you leave this field empty. If these two values are not specified as well, TeamCity uses the JDK home on which the build agent process is started.

JVM command line parameters

Specify JVM command line parameters, for example, maximum heap size or parameters enabling remote debugging. These values are passed by the JVM used to run your build. For example:

-Xmx512m -Xms256m

Local Artifact Repository Settings

Select Use own local repository for this build configuration to isolate this build configuration's artifacts repository from other local repositories.

Incremental Building

Select Build only modules affected by changes check box to enable incremental building of Maven modules. The general idea is that if you have a number of modules interconnected by dependencies, a change most probably affects (directly or transitively) only some of them, so if we build only affected modules and take the result of building the rest of the modules from the previous build we will have the overall result equal to the result of building the whole project from scratch with less effort and faster.

Since Maven itself has very limited support for incremental builds, TeamCity uses its own change impact analysis algorithm for determining the set of affected modules and uses a special preliminary phase for making dependencies of the affected modules.

First TeamCity performs own change impact analysis taking into account parent relationship and different dependency scopes and determines affected modules. Then the build is split into two sequential Maven executions.

The first Maven execution called preparation phase is intended for building the dependencies of affected modules. The preparation phase is to assure there will be no compiler or other errors during the second execution caused by absence or inconsistency of dependency classes.

The second Maven execution called main phase executes the main goal (for example, test), thus performing only those tests affected by the change.

Code Coverage

Coverage support based on IDEA coverage engine is added to Maven runner. To learn about configuring code coverage options, please refer to the Configuring Java Code Coverage page.

Last modified: 20 April 2023