feat: Add 'results' output

Author: smockle

.github/actions/fix/README.md

@@ -17,3 +17,9 @@ Attempts to fix issues with Copilot.
 #### `token`
 
 **Required** Personal access token (PAT) with fine-grained permissions 'issues: write' and 'pull_requests: write'.
+
+### Outputs
+
+#### `fixings`
+
+List of pull requests filed (and their associated issues), as stringified JSON. For example: `'[{"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},"pullRequest":{"url":"https://github.com/github/docs/pulls/124"}}]'`

.github/actions/fix/action.yml

@@ -12,6 +12,10 @@ inputs:
     description: "Personal access token (PAT) with fine-grained permissions 'issues: write' and 'pull_requests: write'"
     required: true
 
+outputs:
+  fixings:
+    description: "List of pull requests filed (and their associated issues), as stringified JSON"
+
 runs:
   using: "node24"
   main: "bootstrap.js"

.github/actions/fix/src/Issue.ts

@@ -1,12 +1,6 @@
-import { IssueInput } from "./types.d.js";
+import { Issue as IssueInput } from "./types.d.js";
 
-interface IIssue extends IssueInput{
-  owner: string;
-  repository: string;
-  issueNumber: number;
-}
-
-export class Issue implements IIssue {
+export class Issue implements IssueInput {
   /**
    * 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`).

.github/actions/fix/src/fixIssue.ts

@@ -54,7 +54,7 @@ export async function fixIssue(octokit: Octokit, { owner, repository, issueNumbe
     return;
   }
   // Assign issue to Copilot
-  await octokit.graphql<{
+  const response = await octokit.graphql<{
     replaceActorsForAssignable: {
       assignable: {
         id: string;
@@ -83,4 +83,9 @@ export async function fixIssue(octokit: Octokit, { owner, repository, issueNumbe
     }`,
     { issueId, assigneeId: suggestedActorsResponse?.repository?.suggestedActors?.nodes[0]?.id }
   );
+  return {
+    nodeId: response.replaceActorsForAssignable.assignable.id,
+    url: response.replaceActorsForAssignable.assignable.url,
+    title: response.replaceActorsForAssignable.assignable.title,
+  }
 }

.github/actions/fix/src/index.ts

@@ -1,4 +1,4 @@
-import type { IssueInput } from "./types.d.js";
+import type { Issue as IssueInput, Fixing } from "./types.d.js";
 import process from "node:process";
 import core from "@actions/core";
 import { Octokit } from "@octokit/core";
@@ -40,17 +40,27 @@ export default async function () {
       },
     },
   });
-  for (const issueInput of issues) {
+  const fixings: Fixing[] = issues.map((issue) => ({ issue })) as Fixing[];
+
+  for (const fixing of fixings) {
     try {
-      const issue = new Issue(issueInput);
-      await fixIssue(octokit, issue);
+      const issue = new Issue(fixing.issue);
+      const response = await fixIssue(octokit, issue);
+      if (response) {
+        fixing.pullRequest = response;
+      }
       core.info(
         `Assigned ${issue.owner}/${issue.repository}#${issue.issueNumber} to Copilot!`
       );
     } catch (error) {
-      core.setFailed(`Failed to assign ${issueInput.url} to Copilot: ${error}`);
+      core.setFailed(
+        `Failed to assign ${fixing.issue.url} to Copilot: ${error}`
+      );
       process.exit(1);
     }
   }
+
+  core.setOutput("fixings", JSON.stringify(fixings));
+  core.debug(`Output: 'fixings: ${JSON.stringify(fixings)}'`);
   core.info("Finished 'fix' action");
 }

.github/actions/fix/src/types.d.ts

@@ -1,4 +1,14 @@
-export type IssueInput = {
+export type Issue = {
   url: string;
   nodeId?: string;
-};
+};
+
+export type PullRequest = {
+  url: string;
+  nodeId?: string;
+};
+
+export type Fixing = {
+  issue: Issue;
+  pullRequest: PullRequest;
+};

.github/workflows/test.yml

@@ -61,7 +61,7 @@ jobs:
         id: cache_key
         shell: bash
         run: |
-          echo "cache_key=$(printf 'cached_filings-%s-%s.json' "${{ matrix.site }}" "${{ github.ref_name }}" | tr -cs 'A-Za-z0-9._-' '_')" >> $GITHUB_OUTPUT
+          echo "cache_key=$(printf 'cached_results-%s-%s.json' "${{ matrix.site }}" "${{ github.ref_name }}" | tr -cs 'A-Za-z0-9._-' '_')" >> $GITHUB_OUTPUT
 
       - name: Scan site (${{ matrix.site }})
         uses: ./
@@ -78,54 +78,12 @@ jobs:
           token: ${{ secrets.GH_TOKEN }}
           cache_key: ${{ steps.cache_key.outputs.cache_key }}
 
-      - name: Retrieve cached filings
+      - name: Retrieve cached results
         uses: ./.github/actions/gh-cache/restore
         with:
           path: ${{ steps.cache_key.outputs.cache_key }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Add PR URLs to filings
-        uses: actions/github-script@v8
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const fs = require('fs');
-            if (!process.env.CACHE_PATH || !fs.existsSync(process.env.CACHE_PATH)) {
-              core.info("Skipping 'Add PR URLs to filings' (no cached filings).");
-              return;
-            }
-            const filings = JSON.parse(fs.readFileSync(process.env.CACHE_PATH, 'utf-8'));
-            for (const filing of filings) {
-              if (!filing?.issue.url) {
-                continue;
-              }
-              const { owner, repo, issueNumber } = /https:\/\/github\.com\/(?<owner>[^/]+)\/(?<repo>[^/]+)\/issues\/(?<issueNumber>\d+)/.exec(filing.issue.url).groups;
-              const query = `query($owner: String!, $repo: String!, $issueNumber: Int!) {
-                repository(owner: $owner, name: $repo) {
-                  issue(number: $issueNumber) {
-                    timelineItems(first: 100, itemTypes: [CONNECTED_EVENT, CROSS_REFERENCED_EVENT]) {
-                      nodes {
-                        ... on CrossReferencedEvent { source { ... on PullRequest { url } } }
-                        ... on ConnectedEvent { subject { ... on PullRequest { url } } }
-                      }
-                    }
-                  }
-                }
-              }`;
-              const variables = { owner, repo, issueNumber: parseInt(issueNumber, 10) }
-              const result = await github.graphql(query, variables)
-              const timelineNodes = result?.repository?.issue?.timelineItems?.nodes || [];
-              const pullRequestNode = timelineNodes.find(n => n?.source?.url || n?.subject?.url);
-              if (pullRequestNode) {
-                filing.pullRequest = { url: pullRequestNode.source?.url || pullRequestNode.subject?.url };
-              } else {
-                core.info(`No pull request found for issue: ${filing.issue.url}`);
-              }
-            }
-            fs.writeFileSync(process.env.CACHE_PATH, JSON.stringify(filings));
-        env:
-          CACHE_PATH: ${{ steps.cache_key.outputs.cache_key }}
-
       - name: Validate scan results (${{ matrix.site }})
         run: |
           npm ci
@@ -140,7 +98,7 @@ jobs:
         run: |
           set -euo pipefail
           if [[ ! -f "${{ steps.cache_key.outputs.cache_key }}" ]]; then
-            echo "Skipping 'Clean up issues and pull requests' (no cached filings)."
+            echo "Skipping 'Clean up issues and pull requests' (no cached results)."
             exit 0
           fi
           jq -r '
@@ -162,7 +120,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Clean up cached filings
+      - name: Clean up cached results
         if: ${{ always() }}
         uses: ./.github/actions/gh-cache/delete
         with:

README.md

@@ -96,7 +96,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 | `urls` | Yes | Newline-delimited list of URLs to scan | `https://primer.style`<br>`https://primer.style/octicons` |
 | `repository` | Yes | Repository (with owner) for issues and PRs | `primer/primer-docs` |
 | `token` | Yes | PAT with write permissions (see above) | `${{ secrets.GH_TOKEN }}` |
-| `cache_key` | Yes | Key for caching findings across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_filings-main-primer.style.json` |
+| `cache_key` | Yes | Key for caching results across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_results-primer.style-main.json` |
 | `login_url` | No | If scanned pages require authentication, the URL of the login page | `https://github.com/login` |
 | `username` | No | If scanned pages require authentication, the username to use for login | `some-user` |
 | `password` | No | If scanned pages require authentication, the password to use for login | `correct-horse-battery-staple` |

action.yml

@@ -13,7 +13,7 @@ inputs:
     description: "Personal access token (PAT) with fine-grained permissions 'contents: write', 'issues: write', and 'pull_requests: write'"
     required: true
   cache_key:
-    description: "Key for caching findings across runs"
+    description: "Key for caching results across runs"
     required: true
   login_url:
     description: "If scanned pages require authentication, the URL of the login page"
@@ -32,6 +32,10 @@ inputs:
     required: false
     default: "false"
 
+outputs:
+  results:
+    description: "List of issues and pull requests filed (and their associated finding(s)), as stringified JSON"
+
 runs:
   using: "composite"
   steps:
@@ -89,11 +93,35 @@ runs:
         issues: ${{ steps.get_issues_from_filings.outputs.issues }}
         repository: ${{ inputs.repository }}
         token: ${{ inputs.token }}
+    - name: Set results output
+      id: results
+      uses: actions/github-script@v8
+      with:
+        script: |
+          const filings = JSON.parse(process.env.FILINGS || '[]');
+          const fixings = JSON.parse(process.env.FIXINGS || '[]');
+          const fixingsByIssueUrl = fixings.reduce((acc, fixing) => {
+            if (fixing.issue && fixing.issue.url) {
+              acc[fixing.issue.url] = fixing;
+            }
+            return acc;
+          }, {});
+          const results = filings;
+          for (const result of results) {
+            if (result.issue && result.issue.url && fixingsByIssueUrl[result.issue.url]) {
+              result.pullRequest = fixingsByIssueUrl[result.issue.url].pullRequest;
+            }
+          }
+          core.setOutput('results', JSON.stringify(results));
+          core.debug(`Results: ${JSON.stringify(results)}`);
+      env:
+        FILINGS: ${{ steps.file.outputs.filings }}
+        FIXINGS: ${{ steps.fix.outputs.fixings }}
     - name: Save cached results
       uses: ./.github/actions/gh-cache/cache
       with:
         key: ${{ inputs.cache_key }}
-        value: ${{ steps.file.outputs.filings }}
+        value: ${{ steps.results.outputs.results }}
         token: ${{ inputs.token }}
 
 branding:

tests/types.d.ts

@@ -19,6 +19,7 @@ export type Issue = {
 
 export type PullRequest = {
   url: string;
+  nodeId: string;
 };
 
 export type Result = {