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!

Buildkite

Covered in this doc

Integrating Percy with your Buildkite 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 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.

Keep your Percy token secret

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

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:

  environment:
    - BUILDKITE
    - BUILDKITE_COMMIT
    - BUILDKITE_BRANCH
    - BUILDKITE_PULL_REQUEST
    - BUILDKITE_BUILD_ID
    - PERCY_TOKEN

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


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

Buildkite


Suggested Edits are limited on API Reference Pages

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