Percy Developer Hub

Welcome to the Percy Developer Hub. You'll find comprehensive guides and documentation to help you start working with Percy as quickly as possible, as well as support if you get stuck. Let's jump right in!

Covered in this doc

Integrating Percy with your Jenkins CI environment

Configuring 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.

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

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

export PERCY_TOKEN=

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

Keep your Percy token secret

Anyone with access to your token can add builds to your project, though they cannot read data.

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


What's next

If you haven't installed and configured an SDK or source code integration, those are your next steps to getting started with visual testing.

SDKs overview
Source code integrations

Jenkins


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.