Skip to main content
Transform your testing process with: Company-wide Licences, Test Observability & App Percy

Integrate Percy with BuildKite

Integrate Percy with BuildKite, a popular CI-CD tool

Follow these steps to integrate Percy with BuildKite:

Configuring environment variables

Start by configuring PERCY_TOKEN, our project-specific, write-only API token. It can be found in your Percy project settings and add it to your Buildkite build pipeline config or agent hooks.

In your Buildkite pipeline, go to Settings > Steps > Environment Variables.

Then set PERCY_TOKEN to the write-only token from your Percy project. This token can be found in each Percy project’s settings.

Percy Token - BuildKite

Keep your Percy token secret.

Anyone with access to your Percy 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.

Setup for docker-compose

If you use Docker containers in your BuildKite builds, you need to pass some environment variables in to your containers for Percy’s client library to detect the environment correctly.

Add this to your docker-compose.yml:

docker-compose.yml
Copy icon Copy snippet

By leaving the value blank, Docker will pass the value from the host BuildKite environment.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy