TeamCity
 
8.0
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. Administrator's Guide
  3. Managing Projects and Build Configurations
  4. Creating and Editing Build Configurations
  5. Configuring VCS Settings
  6. Configuring VCS Roots
  7. Perforce

Perforce

Last modified: 20 April 2023

This page contains descriptions of the fields and options available when setting up VCS roots using Perforce.

note

A Perforce client must be installed on the TeamCity server. Check Perforce VCS compatibility.

If you plan to use the agent-side VCS Checkout Mode, note that a Perforce client must be installed on the agents, and path to p4 executable must be added to the PATH environment variable.

P4 Connection Settings



Option

Description

Port

Specify the Perforce server address. The format is host:port.

Client

Click this radio button to directly specify the client workspace. The workspace should already be created by Perforce client applications like P4V or P4Win. Only mapping rules are used from the configured client workspace. The client name is ignored.

warning

When this option is used with checkout on server mode, internal TeamCity source caching on the server side is disabled, which may worsen the performance of clean checkouts. Also, with this option, snapshot dependencies builds are not reused.

Client Mapping

Click this radio button to specify the mapping of the depot to the client computer. If you have Client mapping selected, TeamCity handles file separators according to OS/platform of a build agent where a build is run. To enforce specific line separator for all build agents, use Client having LineEnd option specified in Perforce instead of Client mapping. Alternatively you can add an Configuring Agent Requirements to run builds only on specific platform.

tip

Use team-city-agent instead of the client name in the mapping.

Example:

//depot/MPS/... //team-city-agent/... //depot/MPS/lib/tools/... //team-city-agent/tools/...

User

Specify the user login name.

Password

Specify the password.

Ticket-based authentication

Check this option to enable ticket-based authentication.

Checkout Settings



Option

Description

Label to checkout

Since TeamCity 7.1. If you need to check out sources not with the latest revision, but with specific Perforce label (with selective changes), you can specify this label here. For instance, this can be useful to produce a milestone/release build, or a reproduce build. If the field is left blank, the latest sources revision will be used for checkout. You can also specify changelist number here.

warning

It is recommended to use agent-side checkout if you use symbolic labels. With server-side checkout on label, TeamCity will perform full checkout.

Workspace options (checkout on agent)

If needed, you can set here the following options for http://www.perforce.com/perforce/doc.092/manuals/cmdref/client.html#1040665 command: Options, SubmitOptions, and LineEnd.

Other Settings



Path to P4 executable

Specify the path to the Perforce command-line client: p4.exe file). This path will be used both for server-side checkout and for agent-side checkout. If you need different values for this path on different build agents when using agent-side checkout, you can set the value using TEAMCITY_P4_PATH environment variable in buildAgent.properties file

Charset

Select the character set used on the client computer.

Support UTF-16 encoding

Enable this option if you have UTF-16 files in your project.

When agent-side checkout is used, TeamCity creates a Perforce workspace for each checkout directory/VCS root. These workspaces are automatically created when necessary and are automatically deleted after some idle time. It is possible to customize the name generated by TeamCity: add teamcity.perforce.workspace.prefix configuration parameter at the Build Parameters page with the prefix in the value.