Adds screenshot repo to ensure we are targeting the correct gh-cache branch

Author: lindseywild

.github/actions/file/action.yml

@@ -14,6 +14,9 @@ inputs:
   cached_filings:
     description: "Cached filings from previous runs, as stringified JSON. Without this, duplicate issues may be filed."
     required: false
+  screenshot_repo:
+    description: "Repository (with owner) where screenshots are stored on the gh-cache branch. Defaults to the 'repository' input if not set."
+    required: false
 
 outputs:
   filings:

.github/actions/file/src/generateIssueBody.ts

@@ -1,6 +1,6 @@
 import type { Finding } from "./types.d.js";
 
-export function generateIssueBody(finding: Finding, repoWithOwner: string): string {
+export function generateIssueBody(finding: Finding, screenshotRepo: string): string {
   const solutionLong = finding.solutionLong
       ?.split("\n")
       .map((line: string) =>
@@ -14,7 +14,7 @@ export function generateIssueBody(finding: Finding, repoWithOwner: string): stri
 
   let screenshotSection;
   if (finding.screenshotId) {
-    const screenshotUrl = `https://github.com/${repoWithOwner}/blob/gh-cache/.screenshots/${finding.screenshotId}.png`;
+    const screenshotUrl = `https://github.com/${screenshotRepo}/blob/gh-cache/.screenshots/${finding.screenshotId}.png`;
     screenshotSection = `
 [View screenshot](${screenshotUrl})
 `;

.github/actions/file/src/index.ts

@@ -20,11 +20,13 @@ export default async function () {
   );
   const repoWithOwner = core.getInput("repository", { required: true });
   const token = core.getInput("token", { required: true });
+  const screenshotRepo = core.getInput("screenshot_repo", { required: false }) || repoWithOwner;
   const cachedFilings: (ResolvedFiling | RepeatedFiling)[] = JSON.parse(
     core.getInput("cached_filings", { required: false }) || "[]"
   );
   core.debug(`Input: 'findings: ${JSON.stringify(findings)}'`);
   core.debug(`Input: 'repository: ${repoWithOwner}'`);
+  core.debug(`Input: 'screenshot_repo: ${screenshotRepo}'`);
   core.debug(`Input: 'cached_filings: ${JSON.stringify(cachedFilings)}'`);
 
   const octokit = new OctokitWithThrottling({
@@ -61,7 +63,7 @@ export default async function () {
         filing.issue.state = "closed";
       } else if (isNewFiling(filing)) {
         // Open a new issue for the filing
-        response = await openIssue(octokit, repoWithOwner, filing.findings[0]);
+        response = await openIssue(octokit, repoWithOwner, filing.findings[0], screenshotRepo);
         (filing as any).issue = { state: "open" } as Issue;
       } else if (isRepeatedFiling(filing)) {
         // Reopen the filing's issue (if necessary) and update the body with the latest finding
@@ -70,6 +72,7 @@ export default async function () {
           new Issue(filing.issue),
           filing.findings[0],
           repoWithOwner,
+          screenshotRepo,
         );
         filing.issue.state = "reopened";
       }

.github/actions/file/src/openIssue.ts

@@ -17,7 +17,7 @@ function truncateWithEllipsis(text: string, maxLength: number): string {
   return text.length > maxLength ? text.slice(0, maxLength - 1) + '…' : text;
 }
 
-export async function openIssue(octokit: Octokit, repoWithOwner: string, finding: Finding) {
+export async function openIssue(octokit: Octokit, repoWithOwner: string, finding: Finding, screenshotRepo?: string) {
   const owner = repoWithOwner.split('/')[0];
   const repo = repoWithOwner.split('/')[1];
 
@@ -27,7 +27,7 @@ export async function openIssue(octokit: Octokit, repoWithOwner: string, finding
     GITHUB_ISSUE_TITLE_MAX_LENGTH,
   );
 
-  const body = generateIssueBody(finding, repoWithOwner);
+  const body = generateIssueBody(finding, screenshotRepo ?? repoWithOwner);
 
   return octokit.request(`POST /repos/${owner}/${repo}/issues`, {
     owner,

.github/actions/file/src/reopenIssue.ts

@@ -8,10 +8,11 @@ export async function reopenIssue(
   { owner, repository, issueNumber }: Issue,
   finding?: Finding,
   repoWithOwner?: string,
+  screenshotRepo?: string,
 ) {
   const body =
     finding && repoWithOwner
-      ? generateIssueBody(finding, repoWithOwner)
+      ? generateIssueBody(finding, screenshotRepo ?? repoWithOwner)
       : undefined;
   return octokit.request(
     `PATCH /repos/${owner}/${repository}/issues/${issueNumber}`,

.github/actions/file/tests/generateIssueBody.test.ts

@@ -47,4 +47,21 @@ describe("generateIssueBody", () => {
     expect(body).not.toContain("- Fix any of the following:");
     expect(body).not.toContain("- Fix all of the following:");
   });
+
+  it("uses the screenshotRepo for the screenshot URL, not the filing repo", () => {
+    const body = generateIssueBody(
+      { ...baseFinding, screenshotId: "abc123" },
+      "github/my-workflow-repo",
+    );
+
+    expect(body).toContain("github/my-workflow-repo/blob/gh-cache/.screenshots/abc123.png");
+    expect(body).not.toContain("github/accessibility-scanner");
+  });
+
+  it("omits screenshot section when screenshotId is not present", () => {
+    const body = generateIssueBody(baseFinding, "github/accessibility-scanner");
+
+    expect(body).not.toContain("View screenshot");
+    expect(body).not.toContain(".screenshots");
+  });
 });

action.yml

@@ -93,6 +93,7 @@ runs:
         repository: ${{ inputs.repository }}
         token: ${{ inputs.token }}
         cached_filings: ${{ steps.normalize_cache.outputs.value }}
+        screenshot_repo: ${{ github.repository }}
     - if: ${{ steps.file.outputs.filings }}
       name: Get issues from filings
       id: get_issues_from_filings