@percy/env

This package provides various CI/CD support for Percy by coalescing different environment variables into a common interface for consumption by `@percy/client`.

latest

Source

npm

Version: 1.31.4

Version published: last month

Weekly downloads: 453K

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

@percy/env

This package provides various CI/CD support for Percy by coalescing different environment variables into a common interface for consumption by @percy/client.

Supported Environments

Percy Environment Variables

The following variables may be defined to override the respective derived CI environment variables.

PERCY_COMMIT          # build commit sha
PERCY_BRANCH          # build branch name
PERCY_PULL_REQUEST    # associated PR number
PERCY_PARALLEL_NONCE  # parallel nonce unique for this CI workflow
PERCY_PARALLEL_TOTAL  # total number of parallel shards

Additional Percy specific environment variable may be set to control aspects of your Percy build.

PERCY_TARGET_COMMIT   # percy target commit sha
PERCY_TARGET_BRANCH   # percy target branch name
PERCY_PARTIAL_BUILD   # if this build was marked as partial

Adding Environment Support

Add CI detection to environment.js
Add respective environment variables
Add a dedicated CI test suite
Open a Pull Request!

FAQs

What is @percy/env?

Is @percy/env popular?

Is @percy/env well maintained?

Package last updated on 16 Oct 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install