Merge branch 'main' into summarize-checks-cutover

Author: mikeharder

.github/dependabot.yml

@@ -38,6 +38,9 @@ updates:
       eslint:
         patterns:
           - "*eslint*"
+      openapi-validator:
+        patterns:
+          - "@microsoft.azure/openapi-validator*"
     versioning-strategy: increase-if-necessary
   - package-ecosystem: "npm"
     directories:

.github/workflows/arm-auto-signoff.yaml

@@ -16,11 +16,17 @@ on:
     types: [completed]
 
 permissions:
+  # actions.listWorkflowRunsForRepo
+  # actions.listWorkflowRunArtifacts
   actions: read
-  checks: read
+  # default
   contents: read
+  # issues.listLabelsOnIssue
   issues: read
+  # issues.listLabelsOnIssue
   pull-requests: read
+  # repos.listCommitStatusesForRef
+  statuses: read
 
 jobs:
   arm-auto-signoff:

.github/workflows/sdk-breaking-change-labels.yaml

@@ -59,7 +59,7 @@ jobs:
           value: "${{ fromJson(steps.get-label-and-action.outputs.result).labelAction == 'add' }}"
 
       - if: ${{ always() && fromJson(steps.get-label-and-action.outputs.result).headSha }}
-        name: Upload artifact with issue number
+        name: Upload artifact with head SHA
         uses: ./.github/actions/add-empty-artifact
         with:
           name: "head-sha"

.github/workflows/src/arm-auto-signoff.js

@@ -56,6 +56,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
   };
 
   // TODO: Try to extract labels from context (when available) to avoid unnecessary API call
+  // permissions: { issues: read, pull-requests: read }
   const labels = await github.paginate(github.rest.issues.listLabelsOnIssue, {
     owner: owner,
     repo: repo,
@@ -72,6 +73,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
 
   core.info(`Labels: ${labelNames}`);
 
+  // permissions: { actions: read }
   const workflowRuns = await github.paginate(github.rest.actions.listWorkflowRunsForRepo, {
     owner,
     repo,
@@ -106,6 +108,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
         return removeAction;
       }
 
+      // permissions: { actions: read }
       const artifacts = await github.paginate(github.rest.actions.listWorkflowRunArtifacts, {
         owner,
         repo,
@@ -143,6 +146,7 @@ export async function getLabelActionImpl({ owner, repo, issue_number, head_sha,
     return removeAction;
   }
 
+  // permissions: { statuses: read }
   const statuses = await github.paginate(github.rest.repos.listCommitStatusesForRef, {
     owner: owner,
     repo: repo,

.github/workflows/src/sdk-breaking-change-labels.js

@@ -39,12 +39,13 @@ export async function getLabelAndAction({ github, context, core }) {
  * @param {string} params.details_url
  * @param {typeof import("@actions/core")} params.core
  * @param {import('./retries.js').RetryOptions} [params.retryOptions]
- * @returns {Promise<{labelName: string | undefined, labelAction: LabelAction, issueNumber: number}>}
+ * @returns {Promise<{labelName: string | undefined, labelAction: LabelAction, headSha: string, issueNumber: number}>}
  */
 export async function getLabelAndActionImpl({ details_url, core, retryOptions = {} }) {
   // Override default logger from console.log to core.info
   retryOptions = { logger: core.info, ...retryOptions };
 
+  let head_sha = "";
   let issue_number = NaN;
   let labelAction;
   /** @type {String | undefined} */
@@ -74,6 +75,9 @@ export async function getLabelAndActionImpl({ details_url, core, retryOptions =
     // Parse the JSON data
     const specGenSdkArtifactInfo = JSON.parse(result.artifactData);
     const labelActionText = specGenSdkArtifactInfo.labelAction;
+
+    head_sha = specGenSdkArtifactInfo.headSha;
+
     issue_number = parseInt(specGenSdkArtifactInfo.prNumber, 10);
     if (!issue_number) {
       core.warning(
@@ -100,5 +104,5 @@ export async function getLabelAndActionImpl({ details_url, core, retryOptions =
     labelAction = LabelAction.None;
   }
 
-  return { labelName, labelAction, issueNumber: issue_number };
+  return { labelName, labelAction, headSha: head_sha, issueNumber: issue_number };
 }

.github/workflows/src/summarize-checks/labelling.js

@@ -411,8 +411,8 @@ export const breakingChangesCheckType = {
  * @returns {void}
  */
 export function processArmReviewLabels(context, existingLabels) {
-  // only kick this off if the ARMReview label is present
-  if (existingLabels.includes("ARMReview")) {
+  // only kick this off if the ARMReview label is present and NotReadyForARMReview is not present
+  if (existingLabels.includes("ARMReview") && !existingLabels.includes("NotReadyForARMReview")) {
     // the important part about how this will work depends how the users use it
     // EG: if they add the "ARMSignedOff" label, we will remove the "ARMChangesRequested" and "WaitForARMFeedback" labels.
     // if they add the "ARMChangesRequested" label, we will remove the "WaitForARMFeedback" label.

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

@@ -85,6 +85,11 @@ export async function updateLabelsImpl({
 
       if (key.startsWith("label-")) {
         const name = key.substring("label-".length);
+
+        if (!name) {
+          throw new Error(`Invalid value for label name: '${name}'`);
+        }
+
         if (value === "true") {
           labelsToAdd.push(name);
         } else if (value === "false") {

.github/workflows/test/sdk-breaking-change-labels.test.js

@@ -188,6 +188,7 @@ describe("sdk-breaking-change-labels", () => {
       expect(result).toEqual({
         labelName: "",
         labelAction: LabelAction.None,
+        headSha: "",
         issueNumber: NaN,
       });
 
@@ -258,6 +259,7 @@ describe("sdk-breaking-change-labels", () => {
       expect(result).toEqual({
         labelName: "",
         labelAction: LabelAction.None,
+        headSha: "",
         issueNumber: NaN,
       });
     });