TeamCity
 
6.5
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. TeamCityReference
  3. Administrator's Guide
  4. Managing Projects and Build Configurations
  5. Creating and Editing Build Configurations
  6. Configuring Build Steps
  7. Maven2

Maven2

Last modified: 20 April 2023

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

warning

Remote Run Limitations related to Maven runner As a rule, a personal build in TeamCity doesn't affect any "regular" builds run on TeamCity server and its results are visible to its initiator only. However, in case of using Maven runner, this behavior may differ. TeamCity doesn't interfere anyhow with Maven dependencies model. Hence, if your Maven configuration deploys artifacts to a remote repository, they will be deployed there even if you run a personal build. Thereby, a personal build may affect builds that depend on your configuration. For example, you have a configuration A that deploys artifacts to a remote repository and these artifacts are used by configuration B. When a personal build for A has finished, your personal artifacts will appear in B. This can be especially injurious, if configuration A is to produce release-version artifacts, because proper artifacts will be replaced with developer's ones, which will be hard to investigate because of Maven versioning model. Plus these artifacts will become available to all dependent builds, not only those managed by TeamCity. To avoid this, we recommend not using remote run for build configurations which perform deployment of artifacts.

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

Maven Parameters



Option

Description

Build runner

Select Maven2 from the drop-down list.

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.

Maven home path

Use this optional parameter to specify path to the executable of your custom Maven. Alternatively, you can set it as %\MAVEN_HOME% environment variable right on a build agent.

tip

You do not need to specify this parameter, if you are going to use the Maven executable that comes bundled with TeamCity (Maven 2.2.1).

Additional Maven command line parameters

Specify the list of command line parameters.

note

The following parameters are ignored: -q, -f, -s (if User settings path is provided)

User settings path

The path to an alternative user settings file. It is equivalent to Maven command line option -s or --settings.

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

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.

tip

Note: only Surefire version 2.4 and higher is supported.

tip

If you have several build agents installed on the same machine, by default they use the same local repository. However there are two ways to designate custom local repository to each build agent:

  • Specify the following property in the teamcity-agent/conf/buildAgent.properties: system.maven.repo.local=%system.agent.work.dir%/<subdirectory name> For instance, %\system.agent.work.dir%/m2-repository

  • Run each build agent under different user account.

See also:

Concepts: Build Runner Administrator's Guide: Configuring Dependency Triggers | Creating and Editing Build Configurations