Upload debug artifacts for upload-sarif

src/upload-sarif-action-post-helper.ts

@@ -0,0 +1,49 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as core from "@actions/core";
+
+import * as actionsUtil from "./actions-util";
+
+export async function run(
+  uploadDebugArtifacts: (
+    toUpload: string[],
+    rootDir: string,
+    artifactName: string,
+  ) => Promise<void>,
+) {
+  const tempDir = actionsUtil.getTemporaryDirectory();
+
+  // Upload Actions SARIF artifacts for debugging
+  if (core.isDebug()) {
+    core.info(
+      "Debug mode is on. Uploading available combined SARIF files as Actions debugging artifact...",
+    );
+
+    const baseTempDir = path.resolve(tempDir, "combined-sarif");
+
+    const toUpload: string[] = [];
+
+    if (fs.existsSync(baseTempDir)) {
+      const outputDirs = fs.readdirSync(baseTempDir);
+
+      for (const outputDir of outputDirs) {
+        const sarifFiles = fs
+          .readdirSync(path.resolve(baseTempDir, outputDir))
+          .filter((f) => f.endsWith(".sarif"));
+
+        for (const sarifFile of sarifFiles) {
+          toUpload.push(path.resolve(baseTempDir, outputDir, sarifFile));
+        }
+      }
+    }
+
+    if (toUpload.length > 0) {
+      await uploadDebugArtifacts(
+        toUpload,
+        baseTempDir,
+        "upload-debug-artifacts",
+      );
+    }
+  }
+}

src/upload-sarif-action-post.ts

@@ -0,0 +1,22 @@
+/**
+ * This file is the entry point for the `post:` hook of `upload-sarif-action.yml`.
+ * It will run after the all steps in this job, in reverse order in relation to
+ * other `post:` hooks.
+ */
+import * as core from "@actions/core";
+
+import * as debugArtifacts from "./debug-artifacts";
+import * as uploadSarifActionPostHelper from "./upload-sarif-action-post-helper";
+import { wrapError } from "./util";
+
+async function runWrapper() {
+  try {
+    await uploadSarifActionPostHelper.run(debugArtifacts.uploadDebugArtifacts);
+  } catch (error) {
+    core.setFailed(
+      `upload-sarif post-action step failed: ${wrapError(error).message}`,
+    );
+  }
+}
+
+void runWrapper();

upload-sarif/action.yml

@@ -38,3 +38,4 @@ outputs:
 runs:
   using: node20
   main: '../lib/upload-sarif-action.js'
+  post: '../lib/upload-sarif-action-post.js'