Integrate App percy with Woodpecker CI

Integrate App percy with Woodpecker CI, a community-driven open-source CI engine

Follow these steps to integrate App percy with Woodpecker CI:

Configuring Woodpecker environment variables

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

In your Woodpecker repository, go to Settings > Secrets and add PERCY_TOKEN. Reference it in your .woodpecker.yml step via the secrets field so the value is available to the step environment.

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

Commit, branch, and pull request information

App percy auto-detects Woodpecker CI builds when CI_SYSTEM_NAME is set to woodpecker (or CI is set to woodpecker). Woodpecker sets CI_SYSTEM_NAME=woodpecker by default; if you override either variable, detection does not run. App percy then reads the following native Woodpecker variables:

• CI_COMMIT_SHA — commit SHA
• CI_COMMIT_BRANCH — branch name
• CI_COMMIT_PULL_REQUEST — pull request number (when CI_PIPELINE_EVENT is pull_request)

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 App percy snapshots via your test suite or another mechanism. Your App percy build will be created with the correct meta-data.

Parallelized build processes

If you parallelize your build across multiple steps or pipelines, PERCY_PARALLEL_TOTAL and PERCY_PARALLEL_NONCE need to be configured. App percy automatically uses Woodpecker’s CI_PIPELINE_NUMBER as the parallel build nonce. Set PERCY_PARALLEL_TOTAL to the total number of parallel builds.

Reference Topic

• Webhook Payloads