Merge pull request #2643 from github/marcogario/robustify_start_proxy…

…_post Start Proxy: Make the post step more robust to errors
github · Dec 11, 2024 · 78d0136 · 78d0136
2 parents c4bbe15 + 47dd68e
commit 78d0136
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 47 deletions.
diff --git a/lib/start-proxy-action-post.js b/lib/start-proxy-action-post.js
diff --git a/lib/start-proxy-action-post.js.map b/lib/start-proxy-action-post.js.map
diff --git a/src/start-proxy-action-post.ts b/src/start-proxy-action-post.ts
@@ -13,40 +13,37 @@ import { getActionsLogger } from "./logging";
 import { checkGitHubVersionInRange, getErrorMessage } from "./util";
 
 async function runWrapper() {
+  const logger = getActionsLogger();
+
   try {
     // Restore inputs from `start-proxy` Action.
     actionsUtil.restoreInputs();
+
+    // Kill the running proxy
     const pid = core.getState("proxy-process-pid");
     if (pid) {
       process.kill(Number(pid));
     }
-  } catch (error) {
-    core.setFailed(
-      `start-proxy post-action step failed: ${getErrorMessage(error)}`,
-    );
-  }
-  const config = await configUtils.getConfig(
-    actionsUtil.getTemporaryDirectory(),
-    core,
-  );
 
-  if ((config && config.debugMode) || core.isDebug()) {
-    const logFilePath = core.getState("proxy-log-file");
-    core.info(
-      "Debug mode is on. Uploading proxy log as Actions debugging artifact...",
+    const config = await configUtils.getConfig(
+      actionsUtil.getTemporaryDirectory(),
+      logger,
     );
-    if (config?.gitHubVersion.type === undefined) {
-      core.warning(
-        `Did not upload debug artifacts because cannot determine the GitHub variant running.`,
-      );
-      return;
-    }
 
-    const logger = getActionsLogger();
-    const gitHubVersion = await getGitHubVersion();
-    checkGitHubVersionInRange(gitHubVersion, logger);
+    if ((config && config.debugMode) || core.isDebug()) {
+      const logFilePath = core.getState("proxy-log-file");
+      logger.info(
+        "Debug mode is on. Uploading proxy log as Actions debugging artifact...",
+      );
+      if (config?.gitHubVersion.type === undefined) {
+        logger.warning(
+          `Did not upload debug artifacts because cannot determine the GitHub variant running.`,
+        );
+        return;
+      }
+      const gitHubVersion = await getGitHubVersion();
+      checkGitHubVersionInRange(gitHubVersion, logger);
 
-    try {
       const artifactUploader = await getArtifactUploaderClient(
         logger,
         gitHubVersion.type,
@@ -61,10 +58,12 @@ async function runWrapper() {
           retentionDays: 7,
         },
       );
-    } catch (e) {
-      // A failure to upload debug artifacts should not fail the entire action.
-      core.warning(`Failed to upload debug artifacts: ${e}`);
     }
+  } catch (error) {
+    // A failure in the post step should not fail the entire action.
+    logger.warning(
+      `start-proxy post-action step failed: ${getErrorMessage(error)}`,
+    );
   }
 }
 

diff --git a/start-proxy/action.yml b/start-proxy/action.yml
@@ -12,6 +12,10 @@ inputs:
   proxy_password:
     required: false
     description: The password of the proxy
+  token:
+    description: GitHub token to use for authenticating with this instance of GitHub, used to upload debug artifacts.
+    default: ${{ github.token }}
+    required: false
 outputs:
   proxy_host:
     description: The IP address of the proxy