check-run: automatically update the conclusion in a post step

In a GitHub Action it is possible to register a `post` Action which will
run, if the main Action has been run in a GitHub workflow's job, as an
extra step after all the regular steps have been executed (or skipped).

This presents a fine opportunity to mark the the Check Run as completed
_automatically_, without the need to call the Action _again_.

By adding a new input called job status and filling it automatically
with -- you guessed it -- the job status, we can even automatically
determine the conclusion (I verified manually that this will receive the
expected value in the `post` Action).

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

check-run/action.yml

@@ -38,12 +38,16 @@ inputs:
   conclusion:
     description: 'If set, the Check Run will be marked as completed'
     default: ''
+  job-status:
+    description: 'Needed at the end of the job'
+    default: ${{ job.status }}
 outputs:
   check-run-id:
     description: 'The ID of the created or updated Check Run'
 runs:
   using: 'node20'
   main: './index.js'
+  post: './post.js'
 branding:
   icon: 'git-commit'
   color: 'orange'

check-run/post.js

@@ -0,0 +1,13 @@
+async function run() {
+  const { CIHelper } = await import("../dist/index.js")
+
+  try {
+    const ci = new CIHelper()
+    ci.setupGitHubAction({ createOrUpdateCheckRun: "post" })
+  } catch (e) {
+    console.error(e)
+    process.exitCode = 1
+  }
+}
+
+run()

lib/ci-helper.ts

@@ -102,7 +102,7 @@ export class CIHelper {
         needsMailingListMirror?: boolean;
         needsUpstreamBranches?: boolean;
         needsMailToCommitNotes?: boolean;
-        createOrUpdateCheckRun?: boolean;
+        createOrUpdateCheckRun?: boolean | "post";
     }): Promise<void> {
         // configure the Git committer information
         process.env.GIT_CONFIG_PARAMETERS = [
@@ -135,7 +135,9 @@ export class CIHelper {
             // Ignore, for now
         }
 
-        if (setupOptions?.createOrUpdateCheckRun) return await this.createOrUpdateCheckRun();
+        if (setupOptions?.createOrUpdateCheckRun) {
+            return await this.createOrUpdateCheckRun(setupOptions.createOrUpdateCheckRun === "post");
+        }
 
         // help dugite realize where `git` is...
         const gitExecutable = os.type() === "Windows_NT" ? "git.exe" : "git";
@@ -285,7 +287,7 @@ export class CIHelper {
         }
     }
 
-    protected async createOrUpdateCheckRun(): Promise<void> {
+    protected async createOrUpdateCheckRun(runPost: boolean): Promise<void> {
         type CheckRunParameters = {
             owner: string;
             repo: string;
@@ -299,6 +301,7 @@ export class CIHelper {
             };
             details_url?: string;
             conclusion?: ConclusionType;
+            job_status?: ConclusionType;
         };
         const params = JSON.parse(core.getState("check-run") || "{}") as CheckRunParameters;
 
@@ -314,7 +317,7 @@ export class CIHelper {
         };
         if (Object.keys(params).length) validateCheckRunParameters();
 
-        ["pr-url", "check-run-id", "name", "title", "summary", "text", "details-url", "conclusion"]
+        ["pr-url", "check-run-id", "name", "title", "summary", "text", "details-url", "conclusion", "job-status"]
             .map((name) => [name.replaceAll("-", "_"), core.getInput(name)] as const)
             .forEach(([key, value]) => {
                 if (!value) return;
@@ -327,6 +330,17 @@ export class CIHelper {
             });
         validateCheckRunParameters();
 
+        if (runPost) {
+            if (!params.check_run_id) {
+                core.info("No Check Run ID found in state; doing nothing");
+                return;
+            }
+            if (!params.conclusion) {
+                Object.assign(params, { conclusion: params.job_status });
+                validateCheckRunParameters();
+            }
+        }
+
         if (params.check_run_id === undefined) {
             ({ id: params.check_run_id } = await this.github.createCheckRun(params));
             core.setOutput("check-run-id", params.check_run_id);