This page contains descriptions of the fields and options available when setting up VCS roots using Perforce.
Common VCS Root properties are described here.
On this page:
- P4 Connection Settings
- Case-Insensitivity in Checkout Rules
- Checkout On Agent Settings
- Other Settings
- Perforce Jobs Support
- Perforce Workspace Handling in TeamCity
- Perforce VCS Compatibility
- Perforce Streams as feature branches
P4 Connection Settings
Specify the Perforce server address. The format is
Click this radio button to specify an existing Perforce stream. TeamCity will use this stream to prepare the stream-based workspace, and will use the client mapping from such a workspace.
TeamCity supports deeper directory structure within the root depot: depots with a depth of
Enable feature branches support (experimental) – select this checkbox to specify branch streams you want to be monitored for changes in addition to the default one. Enter / Edit the branch specification as a newline-delimited set of rules. The syntax is
Click this radio button to directly specify the client workspace name. The workspace must be already created by a Perforce client application like P4V or P4Win. Only the mapping rules from the configured client workspace are used. The client name is ignored.
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 the OS/platform of the build agent where a build is run. To enforce specific line separator for all build agents, use Client or Stream with the
//depot/MPS/... //team-city-agent/... //depot/MPS/lib/tools/... //team-city-agent/tools/...
Now Clean Checkout on a client mapping change is not enforced for the agent-side checkout in the following cases:
If the direct client mapping is changed, a clean checkout will be forced unless the
Specify the user login name.
Password or Ticket
Specify the password or ticket.
If this field is specified, TeamCity
If the password is not specified at all, TeamCity relies on an existing p4 ticket for the current user (
The ticket file, should be present on all build agents where TeamCity runs perforce builds for this VCS root and on the TeamCity server (as the server also executes perforce commands)
Check this option to enable ticket-based authentication. This option is enabled by default and not displayed.
Case-Insensitivity in Checkout Rules
Checkout On Agent Settings
When the 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 the
teamcity.perforce.workspace.prefix configuration parameter at the Parameters page with the prefix in the value.
If needed, you can set here the following options for the p4 client command:
Create non-stream workspace
(Since TeamCity 2018.2) This option is available only when 'Stream' is selected in Connection Settings. Enable the option to be able to checkout using a non-stream workspace based on the stream specification. This allows using checkout rules but makes it impossible to commit to the stream within the build.
Run 'p4 clean' for cleanup
Enable this option to clean up your workspace from extra files before a build (since p4 2014.1). When enabled, the
Skip the have list update
Enable this option not to track files on the Perforce server on sync (always transfer all files to the agent, p4 sync -p).
Extra sync options
Perforce Workspace Parameters
With checkout on agent, TeamCity provides environment variables describing the Perforce workspace created during the checkout process.
If several Perforce VCS Roots are used for the checkout, the variables are created for the first VCS root.The variables are:
P4USER - same as
vcsroot.<VCS root ID>.userparameter
P4PORT - same as
vcsroot.<VCS root ID>.portparameter
P4CLIENT - name of the generated P4 workspace on the agentThese variables can be used to perform custom p4 commands after the checkout.
More information: Perforce Workspace Handling in TeamCity
P4 path on the build agent
Specify the path to the Perforce command-line client:
This field works only on the agent side for agent-side checkout (prior to TeamCity 2017.2.2 this path was used for both the server-side checkout and the agent-side checkout).
To restore old behavior, the
Label/changelist to sync
If you need to check out sources not with the latest revision, but with a 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 changelist will be used for sync.
Select the character set used on the client computer.
Support UTF-16 encoding
Enable this option if you have UTF-16 files stored as
You may want to enable this option if you use server-side checkout and have files of the
If you store
Perforce Jobs Support
For a changelist which was checked in with one or several associated jobs, TeamCity shows a wrench icon which allows you to view details of the jobs when clicked or hovered over.
All Perforce plugin operations are logged into teamcity-vcs.log files with category jetbrains.buildServer.VCS.P4 (on an agent or on a server, depending on the operation context). The detailed logging can be enabled with TeamCity Server Logs.
Perforce Workspace Handling in TeamCity
Refer to a separate page.
Perforce VCS Compatibility
Refer to a separate page.
Perforce Streams as feature branches
Refer to a separate page.
Administrator's Guide: VCS Checkout Mode