Integrate Percy with Jenkins

Integrate Percy with Jenkins, a popular CI-CD tool

Follow these steps to integrate Percy with Jenkins:

Configuring Jenkins environment variables

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

Depending on how you have Jenkins configured, there are a few options for configuring environment variables. Two Jenkins plugins that allow you to configure environment variables include the Build Env Propagator Plugin and the EnvInject plugin.

Alternatively, you could export the variables as part of the build script:

Commit, branch, and pull request information

If you’re using the default GitHub Branch Source Plugin or the equivalent Bitbucket Branch Source Plugin Percy will auto-detect the commit, branch, and pull request details for you from the environment variables the plugins provide.

If you’re not using one of these plugins, please review our environment variables docs page, and configure your environment to include PERCY_COMMIT, PERCY_BRANCH, and PERCY_PULL_REQUEST.

Run your tests

Now with your environment configured, when you 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 processes or nodes, PERCY_PARALLEL_TOTAL and PERCY_PARALLEL_NONCE will need to be configured too. If you’re using one of the Branch Source plugins mentioned above, PERCY_PARALLEL_NONCE will automatically be configured to the BUILD_TAG. Please contact us to discuss how to set these variables to support parallelized build processes.