TeamCity
 
4.0
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. TeamCity Reference
  3. UI Reference
  4. Administration
  5. Create Edit Build Configuration
  6. 2.Version Control Settings

2.Version Control Settings

Last modified: 20 April 2023

Administration > <project> > <build configuration> > Version Control Settings Administration > Configure VCS roots > <vcs root> > Version Control Settings

This page describes the options available on the Version Control Settings page when editing build configurations:

VCS Roots



Option

Description

<VCS root name>

A table of existing VCS roots will appear if they are already attached to the build configuration. Click the name or edit to modify it, detach to remove the VCS root from build configuration (it will not be deleted from the project). Click edit Configuring VCS Settings to view or change the selected VCS root's checkout rules.

Attach existing VCS root

This item will appear if the project contains VCS roots that are not already attached to the particular build configuration. Select the VCS root from the drop-down list to attach it to the build configuration and add it to the table listed above.

Create and attach new VCS root

Click this link to attach a new VCS root. You will be redirected to the New Edit VCS Roots page.

Checkout Settings



Option

Description

VCS checkout mode

Select the desired Configuring VCS Settings from the drop-down list. Options include: Automatically on server (the TeamCity server will check out the sources and pass them to an agent before each build), Automatically on agent (the build agent will check out the sources before the build), and Do not check out files automatically (TeamCity will not check out any sources. The build script will contain the commands to check them out). Note: Agent-side checkout is only supported for CVS and Subversion.

Checkout directory

Specify the directory on the agent where you want the sources to be checked out to and the build process to start. Leave this field blank to use the agent's default build checkout directory.

Clean all files before build

Check this option to perform clean checkout every time a build of this configuration is started.

tip

If you use several VCS roots for a single build configuration, you will probably need to configure Configuring VCS Settings to specify to which directory each root will be checked out.

VCS Labeling



Option

Description

VCS labeling mode

Click a radio button to choose the VCS labeling mode. The possible options are:

  • Do not label: disable labeling

  • Successful only: label successful builds only

  • Always: label all builds

Labeling pattern

This field can be edited if VCS labeling is enabled. The filed defined the name of the label to put in the VCS. The value supports properties references via %<property.name>% syntax. The properties supported as the references include Predefined Properties, Predefined Properties, Defining Properties and Defining Properties.

Choose VCS roots to label

Check each build configuration to be labeled.