[update-labels] Add artifacts head-sha and issue-number (#36531)

Author: mikeharder

.github/workflows/src/update-labels.js

@@ -1,26 +1,52 @@
 // @ts-check
 
+import { isFullGitSha } from "../../shared/src/git.js";
 import { PER_PAGE_MAX } from "../../shared/src/github.js";
 import { extractInputs } from "../src/context.js";
 
 /**
  * @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments
  */
 export default async function updateLabels({ github, context, core }) {
-  const { owner, repo, issue_number, run_id } = await extractInputs(github, context, core);
-  await updateLabelsImpl({ owner, repo, issue_number, run_id, github, core });
+  const { owner, repo, head_sha, issue_number, run_id } = await extractInputs(
+    github,
+    context,
+    core,
+  );
+  await updateLabelsImpl({ owner, repo, head_sha, issue_number, run_id, github, core });
 }
 
 /**
  * @param {Object} params
  * @param {string} params.owner
  * @param {string} params.repo
+ * @param {string} params.head_sha
  * @param {number} params.issue_number
  * @param {number} params.run_id
  * @param {(import("@octokit/core").Octokit & import("@octokit/plugin-rest-endpoint-methods/dist-types/types.js").Api & { paginate: import("@octokit/plugin-paginate-rest").PaginateInterface; })} params.github
  * @param {typeof import("@actions/core")} params.core
  */
-export async function updateLabelsImpl({ owner, repo, issue_number, run_id, github, core }) {
+export async function updateLabelsImpl({
+  owner,
+  repo,
+  head_sha,
+  issue_number,
+  run_id,
+  github,
+  core,
+}) {
+  if (isFullGitSha(head_sha)) {
+    core.setOutput("head_sha", head_sha);
+  } else {
+    core.info(`head_sha is not a valid full git SHA: '${head_sha}'`);
+  }
+
+  if (Number.isInteger(issue_number) && issue_number > 0) {
+    core.setOutput("issue_number", issue_number);
+  } else {
+    core.info(`issue_number must be a positive integer: ${issue_number}`);
+  }
+
   /** @type {string[]} */
   let artifactNames = [];
 

.github/workflows/test/update-labels.test.js

@@ -1,10 +1,13 @@
 import { describe, expect, it } from "vitest";
 import { PER_PAGE_MAX } from "../../shared/src/github.js";
+import { fullGitSha } from "../../shared/test/examples.js";
 import updateLabels, { updateLabelsImpl } from "../src/update-labels.js";
 import { createMockCore, createMockGithub, createMockRequestError } from "./mocks.js";
 
 describe("updateLabels", () => {
   it("loads inputs from context", async () => {
+    const core = createMockCore();
+
     const github = createMockGithub();
     github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({
       data: {
@@ -18,7 +21,7 @@ describe("updateLabels", () => {
         action: "completed",
         workflow_run: {
           event: "pull_request",
-          head_sha: "abc123",
+          head_sha: fullGitSha,
           id: 456,
           repository: {
             name: "TestRepoName",
@@ -31,13 +34,10 @@ describe("updateLabels", () => {
       },
     };
 
-    await expect(
-      updateLabels({
-        github: github,
-        context: context,
-        core: createMockCore(),
-      }),
-    ).resolves.toBeUndefined();
+    await expect(updateLabels({ github, context, core })).resolves.toBeUndefined();
+
+    expect(core.setOutput).toBeCalledWith("head_sha", fullGitSha);
+    expect(core.setOutput).toBeCalledWith("issue_number", 123);
 
     expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({
       owner: "TestRepoOwnerLogin",
@@ -68,7 +68,9 @@ describe("updateLabelsImpl", () => {
         github: github,
         core: createMockCore(),
       }),
-    ).rejects.toThrow();
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `[Error: Required input 'run_id' not found in env or context]`,
+    );
 
     expect(github.rest.issues.addLabels).toBeCalledTimes(0);
     expect(github.rest.issues.removeLabel).toBeCalledTimes(0);
@@ -192,7 +194,9 @@ describe("updateLabelsImpl", () => {
         github: github,
         core: createMockCore(),
       }),
-    ).rejects.toThrow();
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `[Error: Invalid value for label 'baz': invalid.  Expected "true" or "false".]`,
+    );
 
     expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({
       owner: "owner",

.github/workflows/update-labels.yaml

@@ -34,9 +34,24 @@ jobs:
             .github
 
       - name: Update Labels
+        id: update-labels
         uses: actions/github-script@v7
         with:
           script: |
             const { default: updateLabels } =
               await import('${{ github.workspace }}/.github/workflows/src/update-labels.js');
             await updateLabels({ github, context, core });
+
+      - if: ${{ always() && steps.update-labels.outputs.head_sha }}
+        name: Upload artifact with head SHA
+        uses: ./.github/actions/add-empty-artifact
+        with:
+          name: head-sha
+          value: ${{ steps.update-labels.outputs.head_sha }}
+
+      - if: ${{ always() && steps.update-labels.outputs.issue_number }}
+        name: Upload artifact with issue number
+        uses: ./.github/actions/add-empty-artifact
+        with:
+          name: issue-number
+          value: ${{ steps.update-labels.outputs.issue_number }}