Integrate Percy with Bitrise

Integrate Percy with Bitrise, a CI-CD platform built for mobile app teams

Follow these steps to integrate Percy with Bitrise:

Configuring Bitrise environment variables

Start by configuring PERCY_TOKEN, our project-specific, write-only API token. It can be found in your Percy project settings.

In your Bitrise app, go to Workflow Editor > Secrets and add PERCY_TOKEN. Mark the secret as Make it protected so its value is hidden in build logs.

Alternatively, you can export the variable as part of your build script:

Commit, branch, and pull request information

Percy auto-detects Bitrise builds via the BITRISE_IO environment variable and reads the following native Bitrise variables:

• BITRISE_GIT_COMMIT — commit SHA
• BITRISE_GIT_BRANCH — branch name
• BITRISE_PULL_REQUEST — pull request number (when the build was triggered by a PR)

If any of these are not set in your environment, configure your environment to include PERCY_COMMIT, PERCY_BRANCH, and PERCY_PULL_REQUEST. See the environment variables docs page for more details.

Run your tests

With your environment configured, run your Percy snapshots via your test suite or another mechanism. Your Percy build will be created with the correct meta-data.

Parallelized build processes

If you parallelize your build across multiple workflows or machines, PERCY_PARALLEL_TOTAL and PERCY_PARALLEL_NONCE need to be configured. Percy automatically uses Bitrise’s BITRISE_BUILD_NUMBER as the parallel build nonce. Set PERCY_PARALLEL_TOTAL to the total number of parallel builds.

Reference Topic

• Webhook Payloads