feat: Log the remote run URL when found.

Author: Codex-

dist/index.js

@@ -7,6 +7,7 @@ import {
   getWorkflowId,
   getWorkflowRunIds,
   getWorkflowRunJobSteps,
+  getWorkflowRunUrl,
   init,
   retryOrDie,
 } from "./api";
@@ -22,6 +23,9 @@ const mockOctokit = {
       createWorkflowDispatch: async (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
+      getWorkflowRun: async (_req?: any): Promise<MockResponse> => {
+        throw new Error("Should be mocked");
+      },
       listRepoWorkflows: async (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
@@ -360,6 +364,37 @@ describe("API", () => {
     });
   });
 
+  describe("getWorkflowRunUrl", () => {
+    it("should return the workflow run state for a given run ID", async () => {
+      const mockData = {
+        html_url: "master sword",
+      };
+      jest.spyOn(mockOctokit.rest.actions, "getWorkflowRun").mockReturnValue(
+        Promise.resolve({
+          data: mockData,
+          status: 200,
+        })
+      );
+
+      const url = await getWorkflowRunUrl(123456);
+      expect(url).toStrictEqual(mockData.html_url);
+    });
+
+    it("should throw if a non-200 status is returned", async () => {
+      const errorStatus = 401;
+      jest.spyOn(mockOctokit.rest.actions, "getWorkflowRun").mockReturnValue(
+        Promise.resolve({
+          data: undefined,
+          status: errorStatus,
+        })
+      );
+
+      await expect(getWorkflowRunUrl(0)).rejects.toThrow(
+        `Failed to get Workflow Run state, expected 200 but received ${errorStatus}`
+      );
+    });
+  });
+
   describe("retryOrDie", () => {
     it("should return a populated array", async () => {
       const attempt = async () => {

dist/index.js.map

@@ -89,6 +89,40 @@ export async function getWorkflowId(workflowFilename: string): Promise<number> {
   }
 }
 
+export async function getWorkflowRunUrl(runId: number): Promise<string> {
+  try {
+    // https://docs.github.com/en/rest/reference/actions#get-a-workflow-run
+    const response = await octokit.rest.actions.getWorkflowRun({
+      owner: config.owner,
+      repo: config.repo,
+      run_id: runId,
+    });
+
+    if (response.status !== 200) {
+      throw new Error(
+        `Failed to get Workflow Run state, expected 200 but received ${response.status}`
+      );
+    }
+
+    core.debug(
+      `Fetched Run:\n` +
+        `  Repository: ${config.owner}/${config.repo}\n` +
+        `  Run ID: ${runId}\n` +
+        `  URL: ${response.data.html_url}`
+    );
+
+    return response.data.html_url;
+  } catch (error) {
+    if (error instanceof Error) {
+      core.error(
+        `getWorkflowRunUrl: An unexpected error has occurred: ${error.message}`
+      );
+      error.stack && core.debug(error.stack);
+    }
+    throw error;
+  }
+}
+
 export async function getWorkflowRunIds(workflowId: number): Promise<number[]> {
   try {
     const branchName = getBranchName(config.ref);

src/api.spec.ts

@@ -60,7 +60,12 @@ async function run(): Promise<void> {
 
           for (const step of steps) {
             if (idRegex.test(step)) {
-              core.info(`Successfully identified remote Run ID: ${id}`);
+              const url = await api.getWorkflowRunUrl(id);
+              core.info(
+                "Successfully identified remote Run:\n" +
+                  `  Run ID: ${id}\n` +
+                  `  URL: ${url}`
+              );
               core.setOutput(ActionOutputs.runId, id);
               return;
             }