TeamCity 2019.2 Help

VCS Checkout Rules

VCS Checkout Rules allow you to check out a part of the configured VCS root and to map directories from the version control to subdirectories in the build checkout directory on a build agent. Thus, you can define a VCS root for the entire repository and make each build configuration checkout only the relevant part of it.

The Checkout Rules affect the changes displayed in the TeamCity for the build and the files checked out for the build on agent. To display changes, but not to trigger a build for a change, use VCS Trigger Rules.

The general recommendation is to have a small number of VCS roots (pointing to the root of the repository) and define what is checked out by a specific build configuration via checkout rules.

To add a checkout rule, go to the build configuration's Version Control Settings page, locate the VCS root in the list, and click Edit checkout rules to open a form for entering the rules. Use the VCS repository browser VCS-browserIcon.png to select a directory to check out.

Note that Perforce support in TeamCity treats checkout rules as case-sensitive. Case-insensitivity for Perforce-based build configurations can be enabled on the Version Control Settings page by adding the following comment in the Edit Checkout Rules form: ##teamcity ignore-case.

Syntax

In the examples below the paths in the repository (VCSPath) are relative to the configured VCS root, the paths on the agent (AgentPath) are relative to the build checkout directory.

The general syntax of a single checkout rule is as follows:

+|-: VCSPath [=> AgentPath]

When entering rules, note the following:

  • To enter multiple rules, each rule should be entered on a separate line.

  • For each file, the most specific rule will apply if the file is included, regardless of what order the rules are listed in.

  • If you don't enter an operator, it will default to +:.

Rules can be used to perform the following operations:

Syntax

Explanation

+:.=>AgentPath

Checks out the root into the Path directory on a build agent.

-:VCSPath

Excludes VCSPath (the path must be a directory and not a filename).

+:VCSPath=>.

Maps the VCSPath from the VCS to the build agent's default work directory.

VCSPath=>NewAgentPath

Maps the VCSPath from the VCS to the NewAgentPath directory on a build agent.

+:VCSPath

Maps the VCSPath from the VCS to the same-named directory (VCSPath) on a build agent.

An example with three VCS checkout rules:

-:src/help +:src=>production/sources +:src/samples=>./samples

In the above example, the first rule excludes the src/help directory and its contents from checkout. The third rule is more specific than the second rule and maps the src/samples path to the samples path in the build agent's default work directory. The second rule maps the contents of the src path to the production/sources on the build agent, except src/help which was excluded by the first rule and src/samples which was mapped to a different location by the third rule.


See also:

Administrator's Guide: VCS Checkout Mode