@argos-ci/core 2.11.0 → 2.12.0

package/README.md

@@ -1,10 +1,13 @@
 <p align="center">
   <a href="https://argos-ci.com/?utm_source=github&utm_medium=logo" target="_blank">
-    <img src="https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/logo-github-readme.png" alt="Argos" width="300" height="61">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/github-readme-logo-dark.png">
+    <img alt="Argos" src="https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/github-readme-logo-light.png" width="360" height="70">
+  </picture>
   </a>
 </p>
 
-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._
+<p align="center"><strong>The open source visual testing plaform for modern engineering teams.</strong></p>
 
 # Argos JavaScript SDK Core
 

package/dist/index.js

@@ -181,12 +181,16 @@ async function getPullRequestFromHeadSha({ env }, sha) {
     if (!env.DISABLE_GITHUB_TOKEN_WARNING) {
       console.log(
         `
-Running argos from a "deployment_status" event requires a GITHUB_TOKEN.
-Please add \`GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}\` as environment variable.
+Argos couldn\u2019t find a relevant pull request in the current environment.
+To resolve this, Argos requires a GITHUB_TOKEN to fetch the pull request associated with the head SHA. Please ensure the following environment variable is added:
 
-Read more at https://argos-ci.com/docs/run-on-preview-deployment
+GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
 
-To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environment variable.
+For more details, check out the documentation: Read more at https://argos-ci.com/docs/run-on-preview-deployment
+
+If you want to disable this warning, you can set the following environment variable:
+
+DISABLE_GITHUB_TOKEN_WARNING: true
 `.trim()
       );
     }
@@ -225,10 +229,7 @@ To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environme
     return null;
   }
 }
-function getBranch(context, eventPayload) {
-  if (eventPayload?.pull_request?.head.ref) {
-    return eventPayload.pull_request.head.ref;
-  }
+function getBranchFromContext(context) {
   const { env } = context;
   if (env.GITHUB_HEAD_REF) {
     return env.GITHUB_HEAD_REF;
@@ -240,7 +241,16 @@ function getBranch(context, eventPayload) {
   const matches = branchRegex.exec(env.GITHUB_REF);
   return matches?.[1] ?? null;
 }
-function getRepository({ env }) {
+function getBranchFromPayload(payload) {
+  if ("workflow_run" in payload && payload.workflow_run) {
+    return payload.workflow_run.head_branch;
+  }
+  if ("deployment" in payload && payload.deployment) {
+    return payload.deployment.environment;
+  }
+  return null;
+}
+function getRepositoryFromContext({ env }) {
   if (!env.GITHUB_REPOSITORY) return null;
   return env.GITHUB_REPOSITORY.split("/")[1] || null;
 }
@@ -249,6 +259,18 @@ function readEventPayload({ env }) {
   if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
   return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
 }
+function getPullRequestFromPayload(payload) {
+  if ("pull_request" in payload && payload.pull_request && payload.pull_request) {
+    return payload.pull_request;
+  }
+  if ("workflow_run" in payload && payload.workflow_run && payload.workflow_run.pull_requests[0]) {
+    return payload.workflow_run.pull_requests[0];
+  }
+  if ("check_run" in payload && payload.check_run && "pull_requests" in payload.check_run && payload.check_run.pull_requests[0]) {
+    return payload.check_run.pull_requests[0];
+  }
+  return null;
+}
 var service4 = {
   name: "GitHub Actions",
   key: "github-actions",
@@ -260,34 +282,19 @@ var service4 = {
     if (!sha) {
       throw new Error(`GITHUB_SHA is missing`);
     }
-    const commonConfig = {
+    const pullRequest = payload ? getPullRequestFromPayload(payload) : await getPullRequestFromHeadSha(context, sha);
+    return {
       commit: sha,
       owner: env.GITHUB_REPOSITORY_OWNER || null,
-      repository: getRepository(context),
+      repository: getRepositoryFromContext(context),
       jobId: env.GITHUB_JOB || null,
       runId: env.GITHUB_RUN_ID || null,
       runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
-      nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null
-    };
-    if (payload?.deployment) {
-      debug("Deployment event detected");
-      const pullRequest = await getPullRequestFromHeadSha(context, sha);
-      return {
-        ...commonConfig,
-        // If no pull request is found, we fallback to the deployment environment as branch name
-        // Branch name is required to create a build but has no real impact on the build.
-        branch: pullRequest?.head.ref || payload.deployment.environment || null,
-        prNumber: pullRequest?.number || null,
-        prHeadCommit: pullRequest?.head.sha || null,
-        prBaseBranch: null
-      };
-    }
-    return {
-      ...commonConfig,
-      branch: payload?.pull_request?.head.ref || getBranch(context, payload) || null,
-      prNumber: payload?.pull_request?.number || null,
-      prHeadCommit: payload?.pull_request?.head.sha ?? null,
-      prBaseBranch: payload?.pull_request?.base.ref ?? null
+      nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null,
+      branch: getBranchFromContext(context) || pullRequest?.head.ref || (payload ? getBranchFromPayload(payload) : null) || null,
+      prNumber: pullRequest?.number || null,
+      prHeadCommit: pullRequest?.head.sha ?? null,
+      prBaseBranch: pullRequest?.base.ref ?? null
     };
   },
   getMergeBaseCommitSha,
@@ -333,7 +340,7 @@ var getOwner = ({ env }) => {
   if (!env.TRAVIS_REPO_SLUG) return null;
   return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
 };
-var getRepository2 = ({ env }) => {
+var getRepository = ({ env }) => {
   if (!env.TRAVIS_REPO_SLUG) return null;
   return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
 };
@@ -351,7 +358,7 @@ var service6 = {
       commit: env.TRAVIS_COMMIT || null,
       branch: env.TRAVIS_BRANCH || null,
       owner: getOwner(ctx),
-      repository: getRepository2(ctx),
+      repository: getRepository(ctx),
       jobId: null,
       runId: null,
       runAttempt: null,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,8 +40,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.7.0",
-    "@argos-ci/util": "2.2.0",
+    "@argos-ci/api-client": "0.7.1",
+    "@argos-ci/util": "2.2.1",
     "axios": "^1.7.7",
     "convict": "^6.2.4",
     "debug": "^4.3.7",
@@ -50,6 +50,7 @@
     "tmp": "^0.2.3"
   },
   "devDependencies": {
+    "@octokit/webhooks": "^13.4.1",
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/tmp": "^0.2.6",
@@ -59,5 +60,5 @@
     "build": "tsup && cp ./src/index.cjs ./dist",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "a1782b8aa412c3814da4e51d6ef603916a4c7e62"
+  "gitHead": "88672d5cd06a792974844d1cb798641cec6e0562"
 }