TeamCity
 
You are viewing the documentation for an earlier version of TeamCity. View this page in the current documentation

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.

See also

Administrator's Guide