@argos-ci/core 1.4.2-alpha.6 → 1.5.1

package/dist/index.mjs

@@ -118,18 +118,37 @@ const debugTimeEnd = (arg)=>{
 };
 
 /**
- * When triggered by a deployment we try to get the pull request number from the
- * deployment sha.
+ * Get a pull request from a head sha.
+ * Fetch the last 30 pull requests sorted by updated date
+ * then try to find the one that matches the head sha.
+ * If no pull request is found, return null.
  */ async function getPullRequestFromHeadSha({ env }, sha) {
     debug("Fetching pull request number from head sha", sha);
-    if (!env.GITHUB_REPOSITORY || !env.GITHUB_TOKEN) {
-        debug("Aborting because GITHUB_REPOSITORY or GITHUB_TOKEN is missing");
+    if (!env.GITHUB_REPOSITORY) {
+        throw new Error("GITHUB_REPOSITORY is missing");
+    }
+    if (!env.GITHUB_TOKEN) {
+        // For security reasons, people doesn't want to expose their GITHUB_TOKEN
+        // That's why we allow to disable this warning.
+        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.
+
+Read more at https://argos-ci.com/docs/run-on-preview-deployment
+
+To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environment variable.
+`.trim());
+        }
         return null;
     }
     try {
         const result = await axios.get(`https://api.github.com/repos/${env.GITHUB_REPOSITORY}/pulls`, {
             params: {
-                head: sha
+                state: "open",
+                sort: "updated",
+                per_page: 30,
+                page: 1
             },
             headers: {
                 Accept: "application/vnd.github+json",
@@ -141,11 +160,15 @@ const debugTimeEnd = (arg)=>{
             debug("Aborting because no pull request found");
             return null;
         }
-        const firstPr = result.data[0];
-        debug("PR found", firstPr);
-        return firstPr;
+        const matchingPr = result.data.find((pr)=>pr.head.sha === sha);
+        if (matchingPr) {
+            debug("Pull request found", matchingPr);
+            return matchingPr;
+        }
+        debug("Aborting because no pull request found");
+        return null;
     } catch (error) {
-        debug("Error while fetching pull request number from head sha", error);
+        debug("Error while fetching pull request from head sha", error);
         return null;
     }
 }
@@ -154,11 +177,11 @@ const getBranch = ({ env })=>{
         return env.GITHUB_HEAD_REF;
     }
     const branchRegex = /refs\/heads\/(.*)/;
-    const matches = branchRegex.exec(env.GITHUB_REF || "");
-    if (matches) {
-        return matches[1];
+    if (!env.GITHUB_REF) {
+        return null;
     }
-    return null;
+    const matches = branchRegex.exec(env.GITHUB_REF);
+    return (matches === null || matches === void 0 ? void 0 : matches[1]) ?? null;
 };
 const getRepository$1 = ({ env })=>{
     if (!env.GITHUB_REPOSITORY) return null;
@@ -177,7 +200,12 @@ const service$4 = {
         const payload = readEventPayload({
             env
         });
+        const sha = process.env.GITHUB_SHA || null;
+        if (!sha) {
+            throw new Error(`GITHUB_SHA is missing`);
+        }
         const commonConfig = {
+            commit: sha,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
             repository: getRepository$1({
                 env
@@ -189,13 +217,14 @@ const service$4 = {
         // If the job is triggered by from a "deployment" or a "deployment_status"
         if (payload === null || payload === void 0 ? void 0 : payload.deployment) {
             debug("Deployment event detected");
-            const { sha } = payload.deployment;
+            // Try to find a relevant pull request for the sha
             const pullRequest = await getPullRequestFromHeadSha({
                 env
             }, sha);
             return {
                 ...commonConfig,
-                commit: payload.deployment.sha,
+                // 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 === null || pullRequest === void 0 ? void 0 : pullRequest.head.ref) || payload.deployment.environment || null,
                 prNumber: (pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.number) || null,
                 prHeadCommit: (pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.head.sha) || null
@@ -203,7 +232,6 @@ const service$4 = {
         }
         return {
             ...commonConfig,
-            commit: process.env.GITHUB_SHA || null,
             branch: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request = payload.pull_request) === null || _payload_pull_request === void 0 ? void 0 : _payload_pull_request.head.ref) || getBranch({
                 env
             }) || null,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Visual testing solution to avoid visual regression. The core component of Argos SDK that handles build creation.",
-  "version": "1.4.2-alpha.6+505aabe",
+  "version": "1.5.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "505aabe2ed2b8455172e9a8a473bccf683591a7c"
+  "gitHead": "174a9847d8a547d4fa4acb7602ea3687dc9bde8e"
 }