Merge pull request #2197 from github/henrymercer/log-job-status

Log job status in the "Post init" step
github · Mar 13, 2024 · f055b5e · f055b5e
2 parents 0d680ab + e402144
commit f055b5e
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 3 deletions.
diff --git a/lib/init-action-post.js b/lib/init-action-post.js
diff --git a/lib/init-action-post.js.map b/lib/init-action-post.js.map
diff --git a/lib/status-report.js b/lib/status-report.js
diff --git a/lib/status-report.js.map b/lib/status-report.js.map
diff --git a/src/init-action-post.ts b/src/init-action-post.ts
@@ -20,6 +20,7 @@ import {
   createStatusReportBase,
   getActionsStatus,
   ActionName,
+  getJobStatusDisplayName,
 } from "./status-report";
 import {
   checkDiskUsage,
@@ -89,6 +90,9 @@ async function runWrapper() {
     );
     return;
   }
+  const jobStatus = initActionPostHelper.getFinalJobStatus();
+  logger.info(`CodeQL job status was ${getJobStatusDisplayName(jobStatus)}.`);
+
   const statusReportBase = await createStatusReportBase(
     ActionName.InitPost,
     "success",

diff --git a/src/status-report.ts b/src/status-report.ts
@@ -23,6 +23,7 @@ import {
   isInTestMode,
   GITHUB_DOTCOM_URL,
   DiskUsage,
+  assertNever,
 } from "./util";
 
 export enum ActionName {
@@ -171,6 +172,21 @@ export function getActionsStatus(
   }
 }
 
+export function getJobStatusDisplayName(status: JobStatus): string {
+  switch (status) {
+    case JobStatus.SuccessStatus:
+      return "success";
+    case JobStatus.FailureStatus:
+      return "failure";
+    case JobStatus.ConfigErrorStatus:
+      return "configuration error";
+    case JobStatus.UnknownStatus:
+      return "unknown";
+    default:
+      assertNever(status);
+  }
+}
+
 /**
  * Sets the overall job status environment variable to configuration error
  * or failure, unless it's already been set to one of these values in a