Prepare for v1.3.0 (#1038)

smockle · web-flow · commit 8d96292f42be · 2025-09-29T17:29:06.000-04:00
diff --git a/.github/actions/file/README.md b/.github/actions/file/README.md
@@ -36,14 +36,26 @@ List of potential accessibility gaps (plus issue URLs), as stringified JSON. For
 '[]'
 ```
 
+#### `closed_issues`
+
+List of closed issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+
+#### `opened_issues`
+
+List of newly-opened issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+
+#### `repeated_issues`
+
+List of repeated issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+
 #### `closed_issue_urls`
 
-List of URLs for closed issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of URLs for closed issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
 
 #### `opened_issue_urls`
 
-List of URLs for newly-opened issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of URLs for newly-opened issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
 
 #### `repeated_issue_urls`
 
-List of URLs for repeated issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of URLs for repeated issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
diff --git a/.github/actions/file/action.yml b/.github/actions/file/action.yml
@@ -18,12 +18,18 @@ inputs:
 outputs:
   findings:
     description: "List of potential accessibility gaps (plus issue URLs), as stringified JSON"
+  closed_issues:
+    description: "List of closed issues, as stringified JSON"
+  opened_issues:
+    description: "List of newly-opened issues, as stringified JSON"
+  repeated_issues:
+    description: "List of repeated issues, as stringified JSON"
   closed_issue_urls:
-    description: "List of URLs for closed issues, as stringified JSON"
+    description: "DEPRECATED: List of URLs for closed issues, as stringified JSON"
   opened_issue_urls:
-    description: "List of URLs for newly-opened issues, as stringified JSON"
+    description: "DEPRECATED: List of URLs for newly-opened issues, as stringified JSON"
   repeated_issue_urls:
-    description: "List of URLs for repeated issues, as stringified JSON"
+    description: "DEPRECATED: List of URLs for repeated issues, as stringified JSON"
 
 runs:
   using: "node20"
diff --git a/.github/actions/file/src/index.ts b/.github/actions/file/src/index.ts
@@ -1,4 +1,4 @@
-import type { Finding } from "./types.d.js";
+import type { Finding, Issue } from "./types.d.js";
 import process from "node:process";
 import core from "@actions/core";
 import { Octokit } from "@octokit/core";
@@ -40,15 +40,27 @@ export default async function () {
       },
     }
   });
-  const closedIssueUrls = [];
-  const openedIssueUrls = [];
-  const repeatIssueUrls = [];
+  const closedIssues: Issue[] = [];
+  const openedIssues: Issue[] = [];
+  const repeatedIssues: Issue[] = [];
+  /** @deprecated Use `closedIssues` instead. */
+  const closedIssueUrls: string[] = [];
+  /** @deprecated Use `openedIssues` instead. */
+  const openedIssueUrls: string[] = [];
+  /** @deprecated Use `repeatedIssues` instead. */
+  const repeatedIssueUrls: string[] = [];
 
   for (const cachedFinding of cachedFindings) {
     if (!findingsMap.has(`${cachedFinding.url};${cachedFinding.problemShort};${cachedFinding.html}`)) {
       try {
         // Finding was not found in the latest run, so close its issue (if necessary)
         const response = await closeIssueForFinding(octokit, repoWithOwner, cachedFinding);
+        closedIssues.push({
+          id: response.data.id,
+          nodeId: response.data.node_id,
+          url: response.data.html_url,
+          title: response.data.title,
+        });
         closedIssueUrls.push(response.data.html_url);
         core.info(`Closed issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       } catch (error) {
@@ -66,10 +78,22 @@ export default async function () {
       finding.issueUrl = response.data.html_url;
       if (response.data.html_url === cachedIssueUrl) {
         // Finding was found in previous and latest runs, so reopen its issue (if necessary)
-        repeatIssueUrls.push(response.data.html_url);
+        repeatedIssues.push({
+          id: response.data.id,
+          nodeId: response.data.node_id,
+          url: response.data.html_url,
+          title: response.data.title,
+        });
+        repeatedIssueUrls.push(response.data.html_url);
         core.info(`Repeated issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       } else {
         // New finding was found in the latest run, so create its issue
+        openedIssues.push({
+          id: response.data.id,
+          nodeId: response.data.node_id,
+          url: response.data.html_url,
+          title: response.data.title,
+        });
         openedIssueUrls.push(response.data.html_url);
         core.info(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       }
@@ -79,13 +103,25 @@ export default async function () {
     }
   }
 
+  core.setOutput("closed_issues", JSON.stringify(closedIssues));
+  core.setOutput("opened_issues", JSON.stringify(openedIssues));
+  core.setOutput("repeated_issues", JSON.stringify(repeatedIssues));
+  core.setOutput("findings", JSON.stringify(findings));
+  core.debug(`Output: 'closed_issues: ${JSON.stringify(closedIssues)}'`);
+  core.debug(`Output: 'opened_issues: ${JSON.stringify(openedIssues)}'`);
+  core.debug(`Output: 'repeated_issues: ${JSON.stringify(repeatedIssues)}'`);
+  core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`);
+
+  // Deprecated outputs
   core.setOutput("closed_issue_urls", JSON.stringify(closedIssueUrls));
   core.setOutput("opened_issue_urls", JSON.stringify(openedIssueUrls));
-  core.setOutput("repeated_issue_urls", JSON.stringify(repeatIssueUrls));
-  core.setOutput("findings", JSON.stringify(findings));
+  core.setOutput("repeated_issue_urls", JSON.stringify(repeatedIssueUrls));
+  core.warning("The 'closed_issue_urls' output is deprecated and will be removed in v2. If you use the 'closed_issue_urls' output, please migrate to the 'closed_issues' output.");
   core.debug(`Output: 'closed_issue_urls: ${JSON.stringify(closedIssueUrls)}'`);
+  core.warning("The 'opened_issue_urls' output is deprecated and will be removed in v2. If you use the 'opened_issue_urls' output, please migrate to the 'opened_issues' output.");
   core.debug(`Output: 'opened_issue_urls: ${JSON.stringify(openedIssueUrls)}'`);
-  core.debug(`Output: 'repeated_issue_urls: ${JSON.stringify(repeatIssueUrls)}'`);
-  core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`);
+  core.warning("The 'repeated_issue_urls' output is deprecated and will be removed in v2. If you use the 'repeated_issue_urls' output, please migrate to the 'repeated_issues' output.");
+  core.debug(`Output: 'repeated_issue_urls: ${JSON.stringify(repeatedIssueUrls)}'`);
+
   core.info("Finished 'file' action");
 }
diff --git a/.github/actions/file/src/types.d.ts b/.github/actions/file/src/types.d.ts
@@ -8,4 +8,11 @@ export type Finding = {
   solutionShort: string;
   solutionLong?: string;
   issueUrl?: string;
+}
+
+export type Issue = {
+  id: number;
+  nodeId: string;
+  url: string;
+  title: string;
 }
diff --git a/.github/actions/find/package-lock.json b/.github/actions/find/package-lock.json
diff --git a/.github/actions/find/package.json b/.github/actions/find/package.json
@@ -15,7 +15,7 @@
   "dependencies": {
     "@actions/core": "^1.11.1",
     "@axe-core/playwright": "^4.10.2",
-    "playwright": "^1.55.0"
+    "playwright": "^1.55.1"
   },
   "devDependencies": {
     "@types/node": "^24.5.2",
diff --git a/.github/actions/find/src/findForUrl.ts b/.github/actions/find/src/findForUrl.ts
@@ -15,11 +15,11 @@ export async function findForUrl(url: string): Promise<Finding[]> {
       scannerType: 'axe',
       url,
       html: violation.nodes[0].html,
-      problemShort: violation.help.toLowerCase(),
-      problemUrl: violation.helpUrl,
+      problemShort: violation.help.toLowerCase().replace(/[']/g, '’'),
+      problemUrl: violation.helpUrl.replace(/[']/g, '’'),
       ruleId: violation.id,
-      solutionShort: violation.description.toLowerCase(),
-      solutionLong: violation.nodes[0].failureSummary
+      solutionShort: violation.description.toLowerCase().replace(/[']/g, '’'),
+      solutionLong: violation.nodes[0].failureSummary?.replace(/[']/g, '’')
     }));
   } catch (e) {
     // do something with the error
diff --git a/.github/actions/fix/README.md b/.github/actions/fix/README.md
@@ -6,9 +6,13 @@ Attempts to fix issues with Copilot.
 
 ### Inputs
 
+#### `issues`
+
+**NOTE: This input will be unconditionally required in `v2`.** **Required if `issue_urls` is not provided** List of issues to attempt to fix—including, at a minimum, their `url`s—as stringified JSON. For example: `'[{"url":"https://github.com/github/docs/issues/123"},{"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+
 #### `issue_urls`
 
-**Required** List of issue URLs to attempt to fix, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This input will be removed in `v2`.** **Required if `issues` is not provided** List of issue URLs to attempt to fix, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`. If both `issues` and `issue_urls` are provided, `issue_urls` will be ignored.
 
 #### `repository`
 
diff --git a/.github/actions/fix/action.yml b/.github/actions/fix/action.yml
@@ -2,9 +2,12 @@ name: "Fix"
 description: "Attempts to fix issues with Copilot."
 
 inputs:
+  issues:
+    description: "List of issues to attempt to fix, as stringified JSON"
+    required: false
   issue_urls:
     description: "List of issue URLs to attempt to fix, as stringified JSON"
-    required: true
+    required: false
   repository:
     description: "Repository (with owner) containing issues"
     required: true
diff --git a/.github/actions/fix/src/Issue.ts b/.github/actions/fix/src/Issue.ts
@@ -0,0 +1,43 @@
+import { IssueInput } from "./types.d.js";
+
+interface IIssue extends IssueInput{
+  owner: string;
+  repository: string;
+  issueNumber: number;
+}
+
+export class Issue implements IIssue {
+  /**
+   * Extracts owner, repository, and issue number from a GitHub issue URL.
+   * @param issueUrl A GitHub issue URL (e.g. `https://github.com/owner/repo/issues/42`).
+   * @returns An object with `owner`, `repository`, and `issueNumber` keys.
+   * @throws The provided URL is unparseable due to its unexpected format.
+   */
+  static parseIssueUrl(issueUrl: string): { owner: string; repository: string; issueNumber: number } {
+    const { owner, repository, issueNumber } = /\/(?<owner>[^/]+)\/(?<repository>[^/]+)\/issues\/(?<issueNumber>\d+)(?:[/?#]|$)/.exec(issueUrl)?.groups || {};
+    if (!owner || !repository || !issueNumber) {
+      throw new Error(`Could not parse issue URL: ${issueUrl}`);
+    }
+    return { owner, repository, issueNumber: Number(issueNumber) }
+  }
+
+  url: string;
+  nodeId?: string;
+
+  get owner(): string {
+    return Issue.parseIssueUrl(this.url).owner;
+  }
+
+  get repository(): string {
+    return Issue.parseIssueUrl(this.url).repository;
+  }
+
+  get issueNumber(): number {
+    return Issue.parseIssueUrl(this.url).issueNumber;
+  }
+
+  constructor({url, nodeId}: IssueInput) {
+    this.url = url;
+    this.nodeId = nodeId;
+  }
+}
diff --git a/.github/actions/fix/src/fixIssue.ts b/.github/actions/fix/src/fixIssue.ts
@@ -1,10 +1,8 @@
 import type { Octokit } from '@octokit/core';
+import { Issue } from './Issue.js';
 
 // https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/use-copilot-agents/coding-agent/assign-copilot-to-an-issue#assigning-an-existing-issue
-export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl: string) {
-  const owner = repoWithOwner.split('/')[0];
-  const repo = repoWithOwner.split('/')[1];
-  const issueNumber = Number(issueUrl.split('/').pop());
+export async function fixIssue(octokit: Octokit, { owner, repository, issueNumber, nodeId }: Issue) {
   // Check whether issues can be assigned to Copilot
   const suggestedActorsResponse = await octokit.graphql<{
     repository: {
@@ -13,8 +11,8 @@ export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl
       }
     }
   }>(
-    `query ($owner: String!, $repo: String!) {
-      repository(owner: $owner, name: $repo) {
+    `query ($owner: String!, $repository: String!) {
+      repository(owner: $owner, name: $repository) {
         suggestedActors(capabilities: [CAN_BE_ASSIGNED], first: 1) {
           nodes {
             login
@@ -25,30 +23,49 @@ export async function fixIssue(octokit: Octokit, repoWithOwner: string, issueUrl
         }
       }
     }`,
-    { owner, repo },
+    { owner, repository },
   );
   if (suggestedActorsResponse?.repository?.suggestedActors?.nodes[0]?.login !== "copilot-swe-agent") {
     return;
   }
-  // Get GraphQL identifier for issue
-  const issueResponse = await octokit.graphql<{
-    repository: {
-      issue: { id: string }
-    }
-  }>(
-    `query($owner: String!, $repo: String!, $issueNumber: Int!) {
-      repository(owner: $owner, name: $repo) {
-        issue(number: $issueNumber) { id }
+  // Get GraphQL identifier for issue (unless already provided)
+  let issueId = nodeId;
+  if (!issueId) {
+    console.debug(`Fetching identifier for issue ${owner}/${repository}#${issueNumber}`);
+    const issueResponse = await octokit.graphql<{
+      repository: {
+        issue: { id: string }
       }
-    }`,
-    { owner, repo, issueNumber }
-  );
-  const issueId = issueResponse?.repository?.issue?.id;
+    }>(
+      `query($owner: String!, $repository: String!, $issueNumber: Int!) {
+        repository(owner: $owner, name: $repository) {
+          issue(number: $issueNumber) { id }
+        }
+      }`,
+      { owner, repository, issueNumber }
+    );
+    issueId = issueResponse?.repository?.issue?.id;
+    console.debug(`Fetched identifier for issue ${owner}/${repository}#${issueNumber}: ${issueId}`);
+  } else {
+    console.debug(`Using provided identifier for issue ${owner}/${repository}#${issueNumber}: ${issueId}`);
+  }
   if (!issueId) {
+    console.warn(`Couldn’t get identifier for issue ${owner}/${repository}#${issueNumber}. Skipping assignment to Copilot.`);
     return;
   }
   // Assign issue to Copilot
-  return octokit.graphql(
+  await octokit.graphql<{
+    replaceActorsForAssignable: {
+      assignable: {
+        id: string;
+        url: string;
+        title: string;
+        assignees: {
+          nodes: { login: string }[]
+        }
+      }
+    }
+  }>(
     `mutation($issueId: ID!, $assigneeId: ID!) {
       replaceActorsForAssignable(input: {assignableId: $issueId, actorIds: [$assigneeId]}) {
         assignable {
diff --git a/.github/actions/fix/src/index.ts b/.github/actions/fix/src/index.ts
diff --git a/.github/actions/fix/src/types.d.ts b/.github/actions/fix/src/types.d.ts
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
diff --git a/README.md b/README.md
