Ask the Community
Integrate Percy with Argo Workflows
Integrate Percy with Argo Workflows using opt-in detection
Follow these steps to run Percy visual tests as part of your Argo Workflows pipelines and surface workflow context (commit, branch, and pull request) on every build.
Argo Workflows does not auto-inject identifying environment variables into step containers.
To enable detection, expose the variables below via template substitution in your Workflow definition.
Configuring environment variables
Add the following environment variables to your Percy step in your Argo Workflow or WorkflowTemplate. Use Argo’s variables to map workflow context and parameter values to the ARGO_* variables Percy reads.
Variable reference
| Variable | Required | Maps to | Notes |
|---|---|---|---|
ARGO_WORKFLOW_NAME |
Yes | Detection trigger | Set to {{workflow.name}}. Without this, Percy does not auto-detect Argo Workflows. |
ARGO_WORKFLOW_UID |
Recommended | PERCY_PARALLEL_NONCE |
Set to {{workflow.uid}}. Used as the parallel build nonce — required if you parallelize across steps within a workflow. |
ARGO_COMMIT_SHA |
Yes | PERCY_COMMIT |
Set to your commit SHA parameter (typically passed in via workflow parameter). |
ARGO_BRANCH |
Yes | PERCY_BRANCH |
Set to your branch name parameter. |
ARGO_PULL_REQUEST |
No | PERCY_PULL_REQUEST |
Optional. Set when the workflow is associated with a pull request. |
PERCY_TOKEN |
Yes | — | Your project-specific, write-only API token. Store in a Kubernetes Secret and reference via secretKeyRef. |
For more details on overriding commit, branch, and pull request information, see the environment variables docs page.
Keep your Percy token secret.
Anyone with access to your Percy token can add builds to your project, though they cannot read data. If your code is public, do not commit the PERCY_TOKEN to your code.
Reference Topic
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!