[EngSys] Add set-status.failureTarget (job | run) (#35682)

.github/workflows/_reusable-set-check-status.yml

@@ -16,6 +16,11 @@ on:
         description: Comma-separated list of labels that, when any is set, causes the check to always pass
         required: true
         type: string
+      failure_target:
+        description: On failure, should target_url point to the "job" or "run"?  Use "run" if you create a job summary, else "job" which points to the failing step.
+        required: false
+        default: job
+        type: string
 
 permissions:
   actions: read
@@ -64,5 +69,6 @@ jobs:
               { github, context, core }, 
               '${{ inputs.monitored_workflow_name }}',
               '${{ inputs.required_check_name }}',
-              '${{ inputs.overriding_label }}'
+              '${{ inputs.overriding_label }}',
+              '${{ inputs.failure_target }}'
             );

.github/workflows/lintdiff-status.yaml

@@ -33,3 +33,4 @@ jobs:
       monitored_workflow_name: "Swagger LintDiff - Analyze Code"
       required_check_name: "Swagger LintDiff"
       overriding_label: "Approved-LintDiff"
+      failure_target: "run"

.github/workflows/src/label.js

@@ -1,20 +1,14 @@
 // @ts-check
 
-// @ts-nocheck Prevent false positive for duplicate typedef and const names
-/**
- * @typedef {"none" | "add" | "remove"} LabelAction
- */
-
 /**
  * @readonly
- * @enum {LabelAction}
+ * @enum {"none" | "add" | "remove"}
  */
 export const LabelAction = Object.freeze({
   None: "none",
   Add: "add",
   Remove: "remove",
 });
-// @ts-check
 
 export const Label = {
   /**

.github/workflows/src/set-status.js

@@ -1,5 +1,14 @@
 // @ts-check
 
+/**
+ * @readonly
+ * @enum {"job" | "run"}
+ */
+export const FailureTarget = Object.freeze({
+  Job: "job",
+  Run: "run",
+});
+
 import { extractInputs } from "./context.js";
 import { CheckConclusion, CheckStatus, CommitStatusState, PER_PAGE_MAX } from "./github.js";
 
@@ -10,13 +19,15 @@ import { CheckConclusion, CheckStatus, CommitStatusState, PER_PAGE_MAX } from ".
  * @param {string} monitoredWorkflowName
  * @param {string} requiredStatusName
  * @param {string} overridingLabel
+ * @param {FailureTarget} [failureTarget] default: FailureTarget.Job
  * @returns {Promise<void>}
  */
 export default async function setStatus(
   { github, context, core },
   monitoredWorkflowName,
   requiredStatusName,
   overridingLabel,
+  failureTarget = FailureTarget.Job,
 ) {
   const { owner, repo, head_sha, issue_number } = await extractInputs(github, context, core);
 
@@ -36,6 +47,7 @@ export default async function setStatus(
     monitoredWorkflowName,
     requiredStatusName,
     overridingLabel,
+    failureTarget,
   });
 }
 /* v8 ignore stop */
@@ -52,6 +64,7 @@ export default async function setStatus(
  * @param {string} params.monitoredWorkflowName
  * @param {string} params.requiredStatusName
  * @param {string} params.overridingLabel
+ * @param {FailureTarget} [params.failureTarget] default: FailureTarget.Job
  * @returns {Promise<void>}
  */
 export async function setStatusImpl({
@@ -65,6 +78,7 @@ export async function setStatusImpl({
   monitoredWorkflowName,
   requiredStatusName,
   overridingLabel,
+  failureTarget = FailureTarget.Job,
 }) {
   // TODO: Try to extract labels from context (when available) to avoid unnecessary API call
   const labels = await github.paginate(github.rest.issues.listLabelsOnIssue, {
@@ -139,15 +153,15 @@ export async function setStatusImpl({
     /**
      * Update target to the "Analyze Code" run, which contains the meaningful output.
      *
-     * @example https://github.com/mikeharder/azure-rest-api-specs/actions/runs/14509047569
+     * @example https://github.com/Azure/azure-rest-api-specs/actions/runs/14509047569
      */
     target_url = run.html_url;
 
-    if (run.conclusion === CheckConclusion.FAILURE) {
+    if (run.conclusion === CheckConclusion.FAILURE && failureTarget === FailureTarget.Job) {
       /**
        * Update target to point directly to the first failed job
        *
-       * @example https://github.com/mikeharder/azure-rest-api-specs/actions/runs/14509047569/job/40703679014?pr=18
+       * @example https://github.com/Azure/azure-rest-api-specs/actions/runs/14509047569/job/40703679014?pr=18
        */
 
       const jobs = await github.paginate(github.rest.actions.listJobsForWorkflowRun, {

.github/workflows/test/set-status.test.js

@@ -1,5 +1,7 @@
+// @ts-check
+
 import { beforeEach, describe, expect, it } from "vitest";
-import { setStatusImpl } from "../src/set-status.js";
+import { FailureTarget, setStatusImpl } from "../src/set-status.js";
 
 import { CheckConclusion, CheckStatus, CommitStatusState } from "../src/github.js";
 import { createMockCore, createMockGithub } from "./mocks.js";
@@ -217,72 +219,86 @@ describe("setStatusImpl", () => {
       CheckStatus.COMPLETED,
       CheckConclusion.SUCCESS,
       CommitStatusState.SUCCESS,
+      FailureTarget.Job,
       "https://test.com/workflow_run_html_url",
     ],
     [
       CheckStatus.COMPLETED,
       CheckConclusion.FAILURE,
       CommitStatusState.FAILURE,
+      FailureTarget.Job,
       "https://test.com/job_html_url?pr=123",
     ],
+    [
+      CheckStatus.COMPLETED,
+      CheckConclusion.FAILURE,
+      CommitStatusState.FAILURE,
+      FailureTarget.Run,
+      "https://test.com/workflow_run_html_url",
+    ],
     [
       CheckStatus.IN_PROGRESS,
       null,
       CommitStatusState.PENDING,
+      FailureTarget.Job,
       "https://test.com/workflow_run_html_url",
     ],
-    [null, null, CommitStatusState.PENDING, "https://test.com/set_status_url"],
-  ])("(%s, %s, %s) => %s", async (checkStatus, checkConclusion, commitStatusState, targetUrl) => {
-    if (checkStatus) {
-      github.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({
-        data: [
-          {
-            name: "[TEST-IGNORE] Swagger Avocado - Analyze Code",
-            status: checkStatus,
-            conclusion: checkConclusion,
-            updated_at: "2025-01-01",
-            html_url: "https://test.com/workflow_run_html_url",
-          },
-        ],
-      });
-
-      if (
-        checkConclusion === CheckConclusion.SUCCESS ||
-        checkConclusion === CheckConclusion.FAILURE
-      ) {
-        github.rest.actions.listJobsForWorkflowRun.mockResolvedValue({
+    [null, null, CommitStatusState.PENDING, FailureTarget.Job, "https://test.com/set_status_url"],
+  ])(
+    "(%s, %s, %s, %s) => %s",
+    async (checkStatus, checkConclusion, commitStatusState, failureTarget, targetUrl) => {
+      if (checkStatus) {
+        github.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({
           data: [
             {
+              name: "[TEST-IGNORE] Swagger Avocado - Analyze Code",
+              status: checkStatus,
               conclusion: checkConclusion,
-              html_url: "https://test.com/job_html_url",
+              updated_at: "2025-01-01",
+              html_url: "https://test.com/workflow_run_html_url",
             },
           ],
         });
+
+        if (
+          checkConclusion === CheckConclusion.SUCCESS ||
+          checkConclusion === CheckConclusion.FAILURE
+        ) {
+          github.rest.actions.listJobsForWorkflowRun.mockResolvedValue({
+            data: [
+              {
+                conclusion: checkConclusion,
+                html_url: "https://test.com/job_html_url",
+              },
+            ],
+          });
+        }
       }
-    }
 
-    await expect(
-      setStatusImpl({
+      await expect(
+        setStatusImpl({
+          owner: "test-owner",
+          repo: "test-repo",
+          head_sha: "test-head-sha",
+          issue_number: 123,
+          target_url: "https://test.com/set_status_url",
+          github,
+          core,
+          monitoredWorkflowName: "[TEST-IGNORE] Swagger Avocado - Analyze Code",
+          requiredStatusName: "[TEST-IGNORE] Swagger Avocado",
+          overridingLabel: "Approved-Avocado",
+          failureTarget,
+        }),
+      ).resolves.toBeUndefined();
+
+      expect(github.rest.repos.createCommitStatus).toBeCalledWith({
         owner: "test-owner",
         repo: "test-repo",
-        head_sha: "test-head-sha",
-        issue_number: 123,
-        target_url: "https://test.com/set_status_url",
-        github,
-        core,
-        monitoredWorkflowName: "[TEST-IGNORE] Swagger Avocado - Analyze Code",
-        requiredStatusName: "[TEST-IGNORE] Swagger Avocado",
-        overridingLabel: "Approved-Avocado",
-      }),
-    ).resolves.toBeUndefined();
-
-    expect(github.rest.repos.createCommitStatus).toBeCalledWith({
-      owner: "test-owner",
-      repo: "test-repo",
-      sha: "test-head-sha",
-      state: commitStatusState,
-      context: "[TEST-IGNORE] Swagger Avocado",
-      target_url: targetUrl,
-    });
-  });
+        sha: "test-head-sha",
+        state: commitStatusState,
+        context: "[TEST-IGNORE] Swagger Avocado",
+        target_url: targetUrl,
+      });
+    },
+  );
 });