Checks out your project from a Perforce/Helix Core depot. Supports workspace templates and direct depot mappings, with incremental syncs for fast builds.

stages {
    perforce.sync()
    // ...
}

With overrides:

stages {
    perforce.sync(
        P4_HOST: 'ssl:perforce.buas.nl:1666',
        P4_FORCE_CLEAN: true
    )
    // ...
}

• Plugin: P4 Plugin
• Credential: Perforce Password or Ticket credential in Jenkins (see Credential Setup below)
• Workspace: A Perforce workspace template or depot mapping (see Workspace Setup below)

1. Connects to the Perforce server using the provided credential
2. Creates or reuses a Jenkins workspace based on the template or depot mapping
3. Performs an incremental sync (only changed files) by default
4. Sets ctx.vcsType, ctx.revision, and ctx.changelist for downstream stages
5. On cleanup, reverts any pending changes in the workspace

• Workspace template (default): Uses the existing Perforce workspace named in P4_WORKSPACE as a template. Simplest option — create the workspace once in P4V and the pipeline reuses its view mapping.

• View mapping (P4_VIEW set): Defines the workspace view directly in the parameter. No existing workspace template needed. Format:

  //depot/MyProject/... //${P4_WORKSPACE}/...
  

  Use ${P4_WORKSPACE} as the client name in the right side of the mapping.

When P4_FORCE_CLEAN is enabled, the sync discards all local files and re-downloads everything. Use this when:

• You suspect corrupted local files
• Build artifacts are interfering with the sync
• You want a guaranteed clean state

You have two options for configuring how the pipeline syncs your Perforce depot:

Create a Perforce workspace to use as a template. The pipeline will clone its view mapping.

In P4V:

1. Right-click an existing template workspace (e.g., jenkins-TemplatePipeline)

2. Select Create/Update Workspace from...

3. Name it to match P4_WORKSPACE (defaults to jenkins-<JOB_NAME>, e.g., jenkins-MyProject)

4. Set Root to C:\Jenkins\<JOB_NAME>

5. Set View to your project's depot path:

   //depot/MyProject/... //jenkins-MyProject/...
   

Via CLI:

p4 client -t jenkins-TemplatePipeline jenkins-MyProject
p4 client jenkins-MyProject  # edit root and view

Set P4_VIEW directly in the pipeline parameters — no workspace template needed:

//depot/MyProject/... //${P4_WORKSPACE}/...

Use ${P4_WORKSPACE} as the client name on the right side. The pipeline creates the workspace automatically.

Tip: Only map the folder containing your .uproject file. Mapping the entire depot wastes sync time and disk space.

These methods are available on the perforce object for advanced usage outside the standard pipeline:

The P4 Plugin supports Password and Ticket credential types.

Use when your Perforce server accepts standard password authentication.

• Kind: Perforce Password Credential
• P4Port: ssl:perforce.buas.nl:1666
• Username: the Perforce username
• Password: the Perforce password
• ID: memorable ID (e.g., p4-myproject)

Use when your Perforce server uses SAML/SSO authentication (as at BUAS).

A Perforce ticket is a session token generated by p4 login. Since BUAS uses SAML authentication, login happens through the browser.

To obtain a ticket:

1. Open a terminal on the Jenkins agent (or any machine with the p4 CLI)

2. Set the server address and username:

   p4 set P4PORT=ssl:perforce.buas.nl:1666
   p4 set P4USER=your-username

3. Check for an existing ticket:

   p4 tickets

   If the output includes a hex string for your user, copy it and skip to step 6.

4. Log in via SAML:

   p4 login -p

   This opens your browser to the SAML identity provider. Complete authentication. The terminal prints a ticket value (hex string like A1B2C3D4E5F6...).

   If the browser doesn't open automatically, the terminal will display a URL to copy/paste.

5. For a long-lived ticket (recommended for CI):

   p4 login -p -a

   The -a flag creates a ticket valid from any IP. The Perforce admin must have enabled long-lived tickets for the account.

6. Copy the hex string.

Create the credential in Jenkins:

• Kind: Perforce Ticket Credential
• P4Port: perforce.buas.nl:1666 (without ssl: prefix)
• SSL connection: check this box
• Username: the Perforce username
• Login with ticket value: paste the hex string
• ID: memorable ID (e.g., p4-myproject)

Click Test Connection to verify, then Create.

Tip: Verify a ticket is still valid with p4 login -s. If expired, repeat p4 login -p.

If Test Connection fails with "Trust not established":

1. Open a terminal on the Jenkins agent

2. Run:

   p4 -p ssl:perforce.buas.nl:1666 trust

3. Type yes to accept the fingerprint

4. Verify: p4 trust -l

Important: Run p4 trust as the same OS user that the Jenkins agent runs as. If Jenkins runs as a different user, copy the .p4trust file to that user's home directory.