@percy/env 1.31.12 → 1.31.13-beta.0

package/README.md

@@ -5,22 +5,86 @@ into a common interface for consumption by `@percy/client`.
 
 ## Supported Environments
 
+Auto-detected based on environment variables that the CI provider sets during a build.
+
 - [AppVeyor](https://www.browserstack.com/docs/percy/ci-cd/appveyor)
+- [Atlassian Bamboo](#supported-environments) (needs doc)
+- [AWS CodeBuild](#supported-environments) (needs doc)
 - [Azure Pipelines](https://www.browserstack.com/docs/percy/ci-cd/azure-pipelines)
 - [Bitbucket Pipelines](https://www.browserstack.com/docs/percy/ci-cd/bitbucket-pipeline)
+- [Bitrise](#supported-environments) (needs doc)
 - [Buildkite](https://www.browserstack.com/docs/percy/ci-cd/buildkite)
 - [CircleCI](https://www.browserstack.com/docs/percy/ci-cd/circleci)
+- [Cloudflare Pages](#supported-environments) (needs doc)
+- [Codemagic](#supported-environments) (needs doc)
 - [Codeship](https://www.browserstack.com/docs/percy/ci-cd/codeship)
 - [Drone CI](https://docs.percy.io/docs/drone)
 - [GitHub Actions](https://www.browserstack.com/docs/percy/ci-cd/github-actions)
 - [GitLab CI](https://www.browserstack.com/docs/percy/ci-cd/gitlab)
+- [GoCD](#supported-environments) (needs doc)
+- [Google Cloud Build](#supported-environments) (needs doc)
+- [Harness CI](#supported-environments) (needs doc)
 - [Heroku CI](#supported-environments) (needs doc)
 - [Jenkins](https://www.browserstack.com/docs/percy/ci-cd/jenkins)
 - [Jenkins PRB](https://www.browserstack.com/docs/percy/ci-cd/jenkins)
 - [Netlify](https://www.browserstack.com/docs/percy/ci-cd/netlify)
 - [Probo.CI](#supported-environments) (needs doc)
 - [Semaphore](https://www.browserstack.com/docs/percy/ci-cd/semaphore)
+- [TeamCity](#supported-environments) (needs doc)
 - [Travis CI](https://www.browserstack.com/docs/percy/ci-cd/travis-ci)
+- [Vercel](#vercel) — see note below
+- [Woodpecker CI](#supported-environments) (needs doc)
+
+## Opt-in Environments
+
+Kubernetes-native pipelines do not inject provider-identifying environment variables
+into step containers by default. To enable Percy detection on these systems, expose
+the following variables via template substitution in your pipeline definition.
+
+### Tekton Pipelines
+
+```yaml
+steps:
+  - name: percy
+    image: node:20
+    env:
+      - name: TEKTON_PIPELINE_RUN          # required — triggers detection
+        value: "$(context.pipelineRun.name)"
+      - name: TEKTON_COMMIT_SHA
+        value: "$(params.commit-sha)"
+      - name: TEKTON_BRANCH
+        value: "$(params.branch)"
+      - name: TEKTON_PULL_REQUEST          # optional
+        value: "$(params.pr-number)"
+```
+
+### Argo Workflows
+
+```yaml
+- name: percy
+  container:
+    image: node:20
+    env:
+      - name: ARGO_WORKFLOW_NAME           # required — triggers detection
+        value: "{{workflow.name}}"
+      - name: ARGO_WORKFLOW_UID            # recommended — used as parallel nonce
+        value: "{{workflow.uid}}"
+      - name: ARGO_COMMIT_SHA
+        value: "{{workflow.parameters.commit-sha}}"
+      - name: ARGO_BRANCH
+        value: "{{workflow.parameters.branch}}"
+      - name: ARGO_PULL_REQUEST            # optional
+        value: "{{workflow.parameters.pr-number}}"
+```
+
+### Vercel
+
+Vercel exposes its `VERCEL_*` system environment variables to the build step only
+when **Automatically expose System Environment Variables** is enabled on the project
+(Settings → Environment Variables). Percy also needs `PERCY_PARALLEL_TOTAL=-1`
+set in the project environment for the parallel nonce to populate from
+`VERCEL_DEPLOYMENT_ID` — otherwise reruns of the same deploy will create separate
+Percy builds instead of deduping.
 
 ## Percy Environment Variables
 

package/dist/environment.js

@@ -18,6 +18,8 @@ export class PercyEnv {
       return 'circle';
     } else if (this.vars.CI_NAME === 'codeship') {
       return 'codeship';
+    } else if (this.vars.CI_SYSTEM_NAME === 'woodpecker' || this.vars.CI === 'woodpecker') {
+      return 'woodpecker';
     } else if (this.vars.DRONE === 'true') {
       return 'drone';
     } else if (this.vars.SEMAPHORE === 'true') {
@@ -42,6 +44,28 @@ export class PercyEnv {
       return 'netlify';
     } else if (this.vars.HARNESS_PROJECT_ID) {
       return 'harness';
+    } else if (this.vars.TEAMCITY_VERSION) {
+      return 'teamcity';
+    } else if (this.vars.CODEBUILD_BUILD_ID) {
+      return 'aws-codebuild';
+    } else if (this.vars.bamboo_buildKey) {
+      return 'bamboo';
+    } else if (this.vars.BITRISE_IO === 'true') {
+      return 'bitrise';
+    } else if (this.vars.CM_BUILD_ID) {
+      return 'codemagic';
+    } else if (this.vars.VERCEL === '1') {
+      return 'vercel';
+    } else if (this.vars.CF_PAGES === '1') {
+      return 'cloudflare-pages';
+    } else if (this.vars.GO_PIPELINE_NAME && this.vars.GO_SERVER_URL) {
+      return 'gocd';
+    } else if (this.vars.BUILD_ID && this.vars.PROJECT_ID && !this.vars.JENKINS_URL) {
+      return 'gcb';
+    } else if (this.vars.TEKTON_PIPELINE_RUN) {
+      return 'tekton';
+    } else if (this.vars.ARGO_WORKFLOW_NAME) {
+      return 'argo-workflows';
     } else if (this.vars.CI) {
       return 'CI/unknown';
     } else {
@@ -103,6 +127,30 @@ export class PercyEnv {
           return ((_github$pull_request = github(this.vars).pull_request) === null || _github$pull_request === void 0 ? void 0 : _github$pull_request.head.sha) || this.vars.GITHUB_SHA;
         case 'harness':
           return this.vars.DRONE_COMMIT_SHA;
+        case 'woodpecker':
+          return this.vars.CI_COMMIT_SHA;
+        case 'teamcity':
+          return this.vars.BUILD_VCS_NUMBER;
+        case 'aws-codebuild':
+          return this.vars.CODEBUILD_RESOLVED_SOURCE_VERSION;
+        case 'bamboo':
+          return this.vars.bamboo_planRepository_revision;
+        case 'bitrise':
+          return this.vars.BITRISE_GIT_COMMIT;
+        case 'codemagic':
+          return this.vars.CM_COMMIT;
+        case 'vercel':
+          return this.vars.VERCEL_GIT_COMMIT_SHA;
+        case 'cloudflare-pages':
+          return this.vars.CF_PAGES_COMMIT_SHA;
+        case 'gocd':
+          return this.vars.GO_REVISION;
+        case 'gcb':
+          return this.vars.COMMIT_SHA;
+        case 'tekton':
+          return this.vars.TEKTON_COMMIT_SHA;
+        case 'argo-workflows':
+          return this.vars.ARGO_COMMIT_SHA;
       }
     })();
     return commit || null;
@@ -149,6 +197,26 @@ export class PercyEnv {
           return this.vars.HEAD;
         case 'harness':
           return this.vars.DRONE_SOURCE_BRANCH || this.vars.DRONE_COMMIT_BRANCH;
+        case 'woodpecker':
+          return this.vars.CI_COMMIT_BRANCH;
+        case 'aws-codebuild':
+          return this.vars.CODEBUILD_WEBHOOK_HEAD_REF;
+        case 'bamboo':
+          return this.vars.bamboo_planRepository_branchName;
+        case 'bitrise':
+          return this.vars.BITRISE_GIT_BRANCH;
+        case 'codemagic':
+          return this.vars.CM_BRANCH;
+        case 'vercel':
+          return this.vars.VERCEL_GIT_COMMIT_REF;
+        case 'cloudflare-pages':
+          return this.vars.CF_PAGES_BRANCH;
+        case 'gcb':
+          return this.vars.BRANCH_NAME;
+        case 'tekton':
+          return this.vars.TEKTON_BRANCH;
+        case 'argo-workflows':
+          return this.vars.ARGO_BRANCH;
       }
     })();
     return (branch === null || branch === void 0 ? void 0 : branch.replace(/^refs\/\w+?\//, '')) || null;
@@ -159,7 +227,7 @@ export class PercyEnv {
     if (this.vars.PERCY_PULL_REQUEST) {
       return this.vars.PERCY_PULL_REQUEST;
     }
-    let pr = ((_this$vars$CIRCLE_PUL, _this$vars$PULL_REQUE, _github$pull_request3, _this$vars$DRONE_COMM) => {
+    let pr = ((_this$vars$CIRCLE_PUL, _this$vars$PULL_REQUE, _github$pull_request3, _this$vars$DRONE_COMM, _this$vars$CODEBUILD_) => {
       switch (this.ci) {
         case 'travis':
           return this.vars.TRAVIS_PULL_REQUEST !== 'false' && this.vars.TRAVIS_PULL_REQUEST;
@@ -193,6 +261,24 @@ export class PercyEnv {
           return (_github$pull_request3 = github(this.vars).pull_request) === null || _github$pull_request3 === void 0 ? void 0 : _github$pull_request3.number;
         case 'harness':
           return this.vars.DRONE_BUILD_EVENT === 'pull_request' && ((_this$vars$DRONE_COMM = this.vars.DRONE_COMMIT_LINK) === null || _this$vars$DRONE_COMM === void 0 ? void 0 : _this$vars$DRONE_COMM.split('/').slice(-1)[0]);
+        case 'woodpecker':
+          return this.vars.CI_PIPELINE_EVENT === 'pull_request' && this.vars.CI_COMMIT_PULL_REQUEST;
+        case 'aws-codebuild':
+          return (_this$vars$CODEBUILD_ = this.vars.CODEBUILD_WEBHOOK_TRIGGER) === null || _this$vars$CODEBUILD_ === void 0 || (_this$vars$CODEBUILD_ = _this$vars$CODEBUILD_.match(/^pr\/(\d+)$/)) === null || _this$vars$CODEBUILD_ === void 0 ? void 0 : _this$vars$CODEBUILD_[1];
+        case 'bamboo':
+          return this.vars.bamboo_repository_pr_key;
+        case 'bitrise':
+          return this.vars.BITRISE_PULL_REQUEST;
+        case 'codemagic':
+          return this.vars.CM_PULL_REQUEST === 'true' && this.vars.CM_PULL_REQUEST_NUMBER;
+        case 'vercel':
+          return this.vars.VERCEL_GIT_PULL_REQUEST_ID;
+        case 'gcb':
+          return this.vars._PR_NUMBER;
+        case 'tekton':
+          return this.vars.TEKTON_PULL_REQUEST;
+        case 'argo-workflows':
+          return this.vars.ARGO_PULL_REQUEST;
       }
     })();
     return pr || null;
@@ -247,6 +333,30 @@ export class PercyEnv {
           return this.vars.GITHUB_RUN_ID;
         case 'harness':
           return this.vars.HARNESS_BUILD_ID;
+        case 'woodpecker':
+          return this.vars.CI_PIPELINE_NUMBER;
+        case 'teamcity':
+          return this.vars.BUILD_NUMBER;
+        case 'aws-codebuild':
+          return this.vars.CODEBUILD_BUILD_ID;
+        case 'bamboo':
+          return this.vars.bamboo_buildResultKey;
+        case 'bitrise':
+          return this.vars.BITRISE_BUILD_NUMBER;
+        case 'codemagic':
+          return this.vars.CM_BUILD_ID;
+        case 'vercel':
+          return this.vars.VERCEL_DEPLOYMENT_ID;
+        case 'cloudflare-pages':
+          return this.vars.CF_PAGES_COMMIT_SHA || null;
+        case 'gocd':
+          return this.vars.GO_PIPELINE_COUNTER && this.vars.GO_STAGE_COUNTER ? `${this.vars.GO_PIPELINE_COUNTER}.${this.vars.GO_STAGE_COUNTER}` : this.vars.GO_PIPELINE_COUNTER;
+        case 'gcb':
+          return this.vars.BUILD_ID;
+        case 'tekton':
+          return this.vars.TEKTON_PIPELINE_RUN;
+        case 'argo-workflows':
+          return this.vars.ARGO_WORKFLOW_UID || this.vars.ARGO_WORKFLOW_NAME;
       }
     })();
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/env",
-  "version": "1.31.12",
+  "version": "1.31.13-beta.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -32,7 +32,7 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/logger": "1.31.12"
+    "@percy/logger": "1.31.13-beta.0"
   },
-  "gitHead": "442fd8d120574657ee9e0c6e84af707a57db9503"
+  "gitHead": "69c6ad10d5724455cebf57f2043adc30559c3b31"
 }