TeamCity 4.0 Help

VCS Checkout Rules

VCS Checkout Rules allow you to exclude paths and/or map paths (copy directories and all their contents) to a different location on the Build Agent during checkout.

To add a checkout rule click the edit checkout rules link on the build configuration's Version Control Settings page and a pop-up window will appear where you can enter the rule.

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

+|- : VCSPath [=> AgentPath]

When entering rules please 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

+:.=>Path

Checks out the root into Path directory

-:PathName

Excludes PathName (note: 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 the Build Agent

+:VCSPath

Maps the VCSPath from the VCS to the same-named directory (VCSPath) on the 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 scr/samples path to the samples path in the Build Agent's default work directory. The second rule maps the contents of the scr path to the production/sources on the build agent, except src/help which was excluded by the first rule and scr/samples which was mapped to a different location by the third rule.

Last modified: 20 April 2023