TeamCity 2020.2 Help

Configuring Build Parameters

Build parameters provide you with flexible means of sharing settings and a convenient way of passing settings into the build.

Types of Build Parameters

Build parameters are name-value pairs, defined by a user or provided by TeamCity, which can be used in a build.

There are three types of build parameters:

TeamCity provides a set of predefined parameters, and administrators can add custom parameters.

The parameters can be defined at different levels (in order of precedence):

  • a specific build (via the Run Custom Build dialog)

  • the Parameters page of Build Configuration Settings or Build Configuration Template

  • the Parameters page of Project Settings; these affect all the build configurations and templates of the project and its subprojects

  • a build agent (the <Agent home>/conf/buildAgent.properties file on the agent)

Any textual setting can reference a parameter. A string in the %parameter.name% format will be substituted with the actual value during the build. If a build references a parameter which is not defined, TeamCity considers it an implicit agent requirement: the build will only run on the agents with this parameter defined.

Parameter name restrictions

The name of a configuration parameter must satisfy the following requirements:

  • contain only the following characters: [a-zA-Z0-9._-*]

  • start with an ASCII letter

The references to parameters which names do not satisfy the above restrictions do not create an implicit requirement.

Defining Build Parameters in Build Configuration

On the Parameters page of Build Configuration Settings you can define the required system properties and environment variables to be passed to the build script and environment when a build is started. Note that you can redefine them when launching a custom build.

Build parameters defined in a build configuration are used only within this configuration. For other ways, refer to Project and Agent Level Build Parameters.

Any user-defined build parameter (system property or environment variable) can reference other parameters by using the following format:

%[env|system].property_name% For example: system.tomcat.libs=%env.CATALINA_HOME%/lib/*.jar

Using Build Parameters in Build Configuration Settings

In most build configuration settings, you can use a reference to a build parameter instead of using the actual value. Before starting a build, TeamCity resolves all references with the available parameters. If there are references that cannot be resolved, they are left as is; a respective warning appears in the build log.

To make a reference to a build parameter, use its name enclosed in percentage signs: for example, %teamcity.build.number%.

Any text appearing between percentage signs TeamCity considers a reference to a property. If the property cannot be found in the build configuration, the reference becomes an implicit agent requirement and such build configuration can only be run on an agent with this property defined. The agent-defined value will be used in the build.

If you want to prevent TeamCity from treating the text in the percentage signs as a reference to a property, use two percentage signs. Every occurrence of %% in the values where property references are supported will be replaced with % before passing the value to the build. For example, if you want to pass %Y%m%d%H%M%S into the build, change it to %%Y%%m%%d%%H%%M%%S.

Where References Can Be Used

Settings

Description

Build runner settings, artifact specification

Any of the properties that are passed into the build

User-defined properties and environment variables

Any of the properties that are passed into the build

Build number format

Only predefined server build properties

VCS root and checkout rules settings

Any of the properties that are passed into the build

VCS label pattern

system.build.number and predefined server build properties

Artifact dependency settings

Only predefined server build properties

If you reference a build parameter in a build configuration and it is not defined there, it becomes an agent requirement for the configuration. The build configuration will be run only on agents that have this property defined.

Password fields can also contain references to parameters, though in this case you cannot see the reference as it is masked as any password value.

For details on using and overriding parameters from dependencies, please refer to this section.

Using Build Parameters in VCS Labeling Pattern and Build Number

In the build number pattern and VCS labeling pattern, you can use the %[env|system].property_name% syntax to reference the properties that are known on the server side:

  • server and reference predefined properties

  • properties defined in the settings of the build configuration on the Parameters page

For example, a VCS revision number can be specified as %build.vcs.number%.

Using Build Parameters in the Build Scripts

All build parameters starting with the env. prefix (environment variables) are passed into the build's process environment (omitting the prefix).

All build parameters starting with system. prefix (system properties) are passed to the supported build script engines and can be referenced there by the property name, without the system. prefix.
Note that this syntax will work in the build script (not in TeamCity settings):

  • For Ant, Maven, and NAnt, use ${<property name>}

  • For MSBuild (Visual Studio 2005/2008 Project Files), use $(<property name>). Note that MSBuild does not support names with dots (.), so you need to replace . with _ when using the property inside a build script.

  • For Gradle, the TeamCity system properties can be accessed as Gradle properties (similar to the ones defined in the gradle.properties file) and are to be referenced as follows:

    • name allowed as a Groovy identifier (the property name does not contain dots):

    println "Custom user property value is $\{customUserProperty\}"
    • name not allowed as a Groovy identifier (the property name contains dots: for example, build.vcs.number.1): project.ext["build.vcs.number.1"]

When TeamCity starts a build process, the following precedence of the build parameters is used (those on top have higher priority):

  • parameters from the project- and agent-level build parameters file

  • predefined parameters

  • parameters defined in the Run Custom Build dialog

  • parameters defined in build configuration settings

  • parameters defined in a project (the parameters defined for a project will be inherited by all its subprojects and build configurations; if required, you can redefine them in a build configuration)

  • parameters defined in a template (if any)

  • parameters defined in the agent's buildAgent.properties file

  • environment variables of the build agent process itself

The resultant set of parameters is also saved into a file which can be accessed by the build script. See the teamcity.build.properties.file system property or TEAMCITY_BUILD_PROPERTIES_FILE environment variable description in Predefined Build Parameters for details.

Last modified: 26 August 2020