Integrate Percy with GoCD

Integrate Percy with GoCD, an open-source CI-CD server

Follow these steps to integrate Percy with GoCD:

Configuring GoCD environment variables

Start by configuring PERCY_TOKEN, our project-specific, write-only API token. It can be found in your Percy project settings.

In your GoCD pipeline, go to Pipeline Settings > Environment Variables and add PERCY_TOKEN. Mark it as Secure so the value is hidden in build logs.

Alternatively, you can export the variable as part of your build script:

Commit, branch, and pull request information

Percy auto-detects GoCD builds via the GO_PIPELINE_NAME and GO_SERVER_URL environment variables and reads the following native GoCD variables:

• GO_REVISION — commit SHA

GoCD does not natively expose branch or pull request information to the build environment. To populate these fields, configure your environment to include PERCY_BRANCH and PERCY_PULL_REQUEST. See the environment variables docs page for more details.

Run your tests

With your environment configured, run your Percy snapshots via your test suite or another mechanism. Your Percy build will be created with the correct meta-data.

Parallelized build processes

If you parallelize your build across multiple stages or jobs, PERCY_PARALLEL_TOTAL and PERCY_PARALLEL_NONCE need to be configured. Percy composes the parallel build nonce from GoCD’s GO_PIPELINE_COUNTER and GO_STAGE_COUNTER (in the format ${counter}.${stage}). Set PERCY_PARALLEL_TOTAL to the total number of parallel builds.

Reference Topic

• Webhook Payloads