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 CodeShip 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 CodeShip settings for a repository.

CodeShip Basic

In your CodeShip project go to Settings > 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.

CodeShip Pro

CodeShip Pro is based on Docker and uses encrypted files to load your environment variables into Docker containers.

You can learn more about encrypting your environment variables for CodeShip Pro builds in their documentation.

More information


CodeShip has more documentation for integrating Percy with your CI/CD builds.

Keep your Percy token secret

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


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

CodeShip


Suggested Edits are limited on API Reference Pages

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