Add runner image version to status report

github · Aug 7, 2023 · 3b25789 · 3b25789
1 parent 7dcb3e5
commit 3b25789
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 2 deletions.
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/lib/status-report.test.js b/lib/status-report.test.js
diff --git a/lib/status-report.test.js.map b/lib/status-report.test.js.map
diff --git a/src/status-report.test.ts b/src/status-report.test.ts
@@ -19,6 +19,7 @@ test("createStatusReportBase", async (t) => {
     process.env["GITHUB_RUN_ATTEMPT"] = "2";
     process.env["GITHUB_RUN_ID"] = "100";
     process.env["GITHUB_SHA"] = "a".repeat(40);
+    process.env["ImageVersion"] = "2023.05.19.1";
     process.env["RUNNER_OS"] = "macOS";
 
     const getRequiredInput = sinon.stub(actionsUtil, "getRequiredInput");
@@ -48,6 +49,7 @@ test("createStatusReportBase", async (t) => {
     t.is(typeof statusReport.job_run_uuid, "string");
     t.is(statusReport.ref, process.env["GITHUB_REF"]);
     t.is(statusReport.runner_available_disk_space_bytes, 100);
+    t.is(statusReport.runner_image_version, process.env["ImageVersion"]);
     t.is(statusReport.runner_os, process.env["RUNNER_OS"]);
     t.is(statusReport.started_at, process.env[EnvVar.WORKFLOW_STARTED_AT]!);
     t.is(statusReport.status, "failure");

diff --git a/src/status-report.ts b/src/status-report.ts
@@ -89,6 +89,10 @@ export interface StatusReportBase {
   runner_arch?: string;
   /** Available disk space on the runner, in bytes. */
   runner_available_disk_space_bytes: number;
+  /**
+   * Version of the runner image, for workflows running on GitHub-hosted runners. Absent otherwise.
+   */
+  runner_image_version?: string;
   /** Action runner operating system (context runner.os). */
   runner_os: string;
   /** Action runner operating system release (x.y.z from os.release()). */
@@ -240,6 +244,10 @@ export async function createStatusReportBase(
   if (codeQlCliVersion !== undefined) {
     statusReport.codeql_version = codeQlCliVersion;
   }
+  const imageVersion = process.env["ImageVersion"];
+  if (imageVersion) {
+    statusReport.runner_image_version = imageVersion;
+  }
 
   return statusReport;
 }