Merge branch 'main' into copilot/add-baseurl-configuration-option

Author: JoyceZhu

.github/actions/file/README.md

@@ -6,12 +6,13 @@ Files GitHub issues to track potential accessibility gaps.
 
 ### Inputs
 
-#### `findings`
+#### `findings_file`
 
-**Required** List of potential accessibility gaps, as stringified JSON. For example:
+**Required** Path to a JSON file containing the list of potential accessibility gaps. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). For example: `findings.json`.
 
-```JS
-'[]'
+The file should contain a JSON array of finding objects. For example:
+```json
+[]
 ```
 
 #### `repository`
@@ -22,12 +23,32 @@ Files GitHub issues to track potential accessibility gaps.
 
 **Required** Token with fine-grained permission 'issues: write'.
 
-#### `cached_filings`
+#### `cached_filings_file`
 
-**Optional** Cached filings from previous runs, as stringified JSON. Without this, duplicate issues may be filed. For example: `'[{"findings":[],"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}}]'`
+**Optional** Path to a JSON file containing cached filings from previous runs. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). Without this, duplicate issues may be filed. For example: `cached-filings.json`.
+
+The file should contain a JSON array of filing objects. For example:
+```json
+[
+  {
+    "findings": [],
+    "issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}
+  }
+]
+```
 
 ### Outputs
 
-#### `filings`
+#### `filings_file`
 
-List of issues filed (and their associated finding(s)), as stringified JSON. For example: `'[{"findings":[],"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}}]'`
+Absolute path to a JSON file containing the list of issues filed (and their associated finding(s)). The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/filings-<uuid>.json`.
+
+The file will contain a JSON array of filing objects. For example:
+```json
+[
+  {
+    "findings": [],
+    "issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}
+  }
+]
+```

.github/actions/file/action.yml

@@ -2,8 +2,8 @@ name: "File"
 description: "Files GitHub issues to track potential accessibility gaps."
 
 inputs:
-  findings:
-    description: "List of potential accessibility gaps, as stringified JSON"
+  findings_file:
+    description: "Path to a JSON file containing the list of potential accessibility gaps"
     required: true
   repository:
     description: "Repository (with owner) to file issues in"
@@ -14,8 +14,8 @@ inputs:
   base_url:
     description: "Optional base URL to pass into Octokit for the GitHub API (for example, `https://YOUR_HOSTNAME/api/v3` for GitHub Enterprise Server)"
     required: false
-  cached_filings:
-    description: "Cached filings from previous runs, as stringified JSON. Without this, duplicate issues may be filed."
+  cached_filings_file:
+    description: "Path to a JSON file containing cached filings from previous runs. Without this, duplicate issues may be filed."
     required: false
   screenshot_repository:
     description: "Repository (with owner) where screenshots are stored on the gh-cache branch. Defaults to the 'repository' input if not set. Required if issues are open in a different repo to construct proper screenshot URLs."
@@ -26,8 +26,8 @@ inputs:
     default: "false"
 
 outputs:
-  filings:
-    description: "List of issues filed (and their associated finding(s)), as stringified JSON"
+  filings_file:
+    description: "Path to a JSON file containing the list of issues filed (and their associated finding(s))"
 
 runs:
   using: "node24"

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

@@ -1,4 +1,6 @@
 import type {Finding, ResolvedFiling, RepeatedFiling, FindingGroupIssue, Filing, IssueResponse} from './types.d.js'
+import fs from 'node:fs'
+import path from 'node:path'
 import process from 'node:process'
 import * as core from '@actions/core'
 import {Octokit} from '@octokit/core'
@@ -16,20 +18,22 @@ const OctokitWithThrottling = Octokit.plugin(throttling)
 
 export default async function () {
   core.info("Started 'file' action")
-  const findings: Finding[] = JSON.parse(core.getInput('findings', {required: true}))
+  const findingsFile = core.getInput('findings_file', {required: true})
+  const findings: Finding[] = JSON.parse(fs.readFileSync(findingsFile, 'utf8'))
   const repoWithOwner = core.getInput('repository', {required: true})
   const token = core.getInput('token', {required: true})
   const baseUrl = core.getInput('base_url', {required: false})
   const screenshotRepo = core.getInput('screenshot_repository', {required: false}) || repoWithOwner
-  const cachedFilings: (ResolvedFiling | RepeatedFiling)[] = JSON.parse(
-    core.getInput('cached_filings', {required: false}) || '[]',
-  )
+  const cachedFilingsFile = core.getInput('cached_filings_file', {required: false})
+  const cachedFilings: (ResolvedFiling | RepeatedFiling)[] = cachedFilingsFile
+    ? JSON.parse(fs.readFileSync(cachedFilingsFile, 'utf8'))
+    : []
   const shouldOpenGroupedIssues = core.getBooleanInput('open_grouped_issues')
-  core.debug(`Input: 'findings: ${JSON.stringify(findings)}'`)
+  core.debug(`Input: 'findings_file: ${findingsFile}'`)
   core.debug(`Input: 'repository: ${repoWithOwner}'`)
   core.debug(`Input: 'base_url: ${baseUrl ?? '(default)'}'`)
   core.debug(`Input: 'screenshot_repository: ${screenshotRepo}'`)
-  core.debug(`Input: 'cached_filings: ${JSON.stringify(cachedFilings)}'`)
+  core.debug(`Input: 'cached_filings_file: ${cachedFilingsFile}'`)
   core.debug(`Input: 'open_grouped_issues: ${shouldOpenGroupedIssues}'`)
 
   const octokit = new OctokitWithThrottling({
@@ -134,7 +138,10 @@ export default async function () {
     }
   }
 
-  core.setOutput('filings', JSON.stringify(filings))
-  core.debug(`Output: 'filings: ${JSON.stringify(filings)}'`)
+  const filingsPath = path.join(process.env.RUNNER_TEMP || '/tmp', `filings-${crypto.randomUUID()}.json`)
+  fs.writeFileSync(filingsPath, JSON.stringify(filings))
+  core.setOutput('filings_file', filingsPath)
+
+  core.debug(`Output: 'filings_file: ${filingsPath}'`)
   core.info("Finished 'file' action")
 }

.github/actions/find/README.md

@@ -41,10 +41,11 @@ configuration option.
 
 ### Outputs
 
-#### `findings`
+#### `findings_file`
 
-List of potential accessibility gaps, as stringified JSON. For example:
+Absolute path to a JSON file containing the list of potential accessibility gaps. The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/findings-<uuid>.json`.
 
-```JS
-'[]'
+The file will contain a JSON array of finding objects. For example:
+```json
+[]
 ```

.github/actions/find/action.yml

@@ -24,8 +24,8 @@ inputs:
     required: false
 
 outputs:
-  findings:
-    description: 'List of potential accessibility gaps, as stringified JSON'
+  findings_file:
+    description: 'Path to a JSON file containing the list of potential accessibility gaps'
 
 runs:
   using: 'node24'

.github/actions/find/src/index.ts

@@ -1,4 +1,6 @@
 import type {AuthContextInput, ColorSchemePreference, ReducedMotionPreference} from './types.js'
+import fs from 'node:fs'
+import path from 'node:path'
 import * as core from '@actions/core'
 import {AuthContext} from './AuthContext.js'
 import {findForUrl} from './findForUrl.js'
@@ -44,8 +46,11 @@ export default async function () {
     core.info(`Found ${findingsForUrl.length} findings for ${url}`)
   }
 
-  core.setOutput('findings', JSON.stringify(findings))
-  core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`)
+  const findingsPath = path.join(process.env.RUNNER_TEMP || '/tmp', `findings-${crypto.randomUUID()}.json`)
+  fs.writeFileSync(findingsPath, JSON.stringify(findings))
+  core.setOutput('findings_file', findingsPath)
+
+  core.debug(`Output: 'findings_file: ${findingsPath}'`)
   core.info(`Found ${findings.length} findings in total`)
   core.info("Finished 'find' action")
 }

.github/actions/fix/README.md

@@ -6,9 +6,18 @@ Attempts to fix issues with Copilot.
 
 ### Inputs
 
-#### `issues`
+#### `issues_file`
 
-**Required** 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"}]'`.
+**Required** Path to a JSON file containing the list of issues to attempt to fix—including, at a minimum, their `url`s. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). For example: `issues.json`.
+
+The file should contain a JSON array of issue objects. For example:
+```json
+[
+  {"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"}
+]
+```
 
 #### `repository`
 
@@ -20,6 +29,16 @@ Attempts to fix issues with Copilot.
 
 ### Outputs
 
-#### `fixings`
+#### `fixings_file`
+
+Absolute path to a JSON file containing the list of pull requests filed (and their associated issues). The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/fixings-<uuid>.json`.
 
-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"}}]'`
+The file will contain a JSON array of fixing objects. For example:
+```json
+[
+  {
+    "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

@@ -2,8 +2,8 @@ name: "Fix"
 description: "Attempts to fix issues with Copilot."
 
 inputs:
-  issues:
-    description: "List of issues to attempt to fix, as stringified JSON"
+  issues_file:
+    description: "Path to a JSON file containing the list of issues to attempt to fix"
     required: true
   repository:
     description: "Repository (with owner) containing issues"
@@ -16,8 +16,8 @@ inputs:
     required: false
 
 outputs:
-  fixings:
-    description: "List of pull requests filed (and their associated issues), as stringified JSON"
+  fixings_file:
+    description: "Path to a JSON file containing the list of pull requests filed (and their associated issues)"
 
 runs:
   using: "node24"

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

@@ -1,4 +1,6 @@
 import type {Issue as IssueInput, Fixing} from './types.d.js'
+import fs from 'node:fs'
+import path from 'node:path'
 import process from 'node:process'
 import * as core from '@actions/core'
 import {Octokit} from '@octokit/core'
@@ -11,11 +13,12 @@ const OctokitWithThrottling = Octokit.plugin(throttling)
 
 export default async function () {
   core.info("Started 'fix' action")
-  const issues: IssueInput[] = JSON.parse(core.getInput('issues', {required: true}) || '[]')
+  const issuesFile = core.getInput('issues_file', {required: true})
+  const issues: IssueInput[] = JSON.parse(fs.readFileSync(issuesFile, 'utf8'))
   const repoWithOwner = core.getInput('repository', {required: true})
   const token = core.getInput('token', {required: true})
   const baseUrl = core.getInput('base_url', {required: false}) || undefined
-  core.debug(`Input: 'issues: ${JSON.stringify(issues)}'`)
+  core.debug(`Input: 'issues_file: ${issuesFile}'`)
   core.debug(`Input: 'repository: ${repoWithOwner}'`)
   core.debug(`Input: 'base_url: ${baseUrl ?? '(default)'}'`)
 
@@ -59,7 +62,10 @@ export default async function () {
     }
   }
 
-  core.setOutput('fixings', JSON.stringify(fixings))
-  core.debug(`Output: 'fixings: ${JSON.stringify(fixings)}'`)
+  const fixingsPath = path.join(process.env.RUNNER_TEMP || '/tmp', `fixings-${crypto.randomUUID()}.json`)
+  fs.writeFileSync(fixingsPath, JSON.stringify(fixings))
+  core.setOutput('fixings_file', fixingsPath)
+
+  core.debug(`Output: 'fixings_file: ${fixingsPath}'`)
   core.info("Finished 'fix' action")
 }

.github/actions/gh-cache/cache/action.yml

@@ -63,6 +63,7 @@ runs:
         echo "value<<EOF" >> $GITHUB_OUTPUT
         if [ -f "${{ inputs.key }}" ]; then
           cat "${{ inputs.key }}" >> $GITHUB_OUTPUT
+          echo >> $GITHUB_OUTPUT
           echo "Outputted 'value=$(cat "${{ inputs.key }}")'"
         else
           echo "Skipped outputting 'value'"