Hey! These docs are for version 1, which is no longer officially supported. Click here for the latest version, 2-web!


Configure Percy environment variables in Jenkins

Percy is designed to integrate with your tests and CI environment. To enable Percy, the token environment variable must be configured in your CI service:

  • PERCY_TOKEN: The Percy repo write-only API token. This is unique for each Percy repository.

Jenkins build setup

Depending on how you have Jenkins configured, there are a few options for configuring environment variables.

You can use the EnvInject plugin to set the token environment variable for a build.

Set PERCY_TOKEN to the write-only token from your Percy repo. This token can be found in each Percy repo's settings.

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

export PERCY_TOKEN=aaabbbcccdddeeefff

# Now run your tests (just an example, this depends on the client library used):
bundle exec rspec


IMPORTANT: Keep your Percy token secret. Anyone with access to your token can consume your account quota, though they cannot read data.

If your code is public, do not commit the PERCY_TOKEN to your code.

Next step: integrate with tests

You're done with setup---the last step is to integrate Percy into your tests and run them. Just choose your client library:




Static sites

Everything else