Skip to content

Replace github-script with file-based approach to avoid large JSON output max limit #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lindseywild merged 2 commits into from
Mar 30, 2026
+55 −21
Merged

Replace github-script with file-based approach to avoid large JSON output max limit #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b55df88
Replace github-script with file-based approach to avoid ARG_MAX limit
lindseywild Mar 26, 2026
1f361d5
Fix missing newline before EOF delimiter in gh-cache/cache output
lindseywild Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/gh-cache/cache/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'"
Expand Down
75 changes: 54 additions & 21 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ outputs:
results:
description: 'List of issues and pull requests filed (and their associated finding(s)), as stringified JSON'
value: ${{ steps.results.outputs.results }}
results_file:
description: 'Path to a JSON file containing the results (use for large datasets to avoid output size limits)'
value: ${{ steps.results.outputs.results_file }}

runs:
using: 'composite'
Expand Down Expand Up @@ -132,38 +135,68 @@ runs:
issues: ${{ steps.get_issues_from_filings.outputs.issues }}
repository: ${{ inputs.repository }}
token: ${{ inputs.token }}
- name: Write filings and fixings to temp files
shell: bash
run: |
cat > "$RUNNER_TEMP/filings.json" << 'FILINGS_HEREDOC_DELIMITER'
${{ steps.file.outputs.filings || '[]' }}
FILINGS_HEREDOC_DELIMITER

cat > "$RUNNER_TEMP/fixings.json" << 'FIXINGS_HEREDOC_DELIMITER'
${{ steps.fix.outputs.fixings || '[]' }}
FIXINGS_HEREDOC_DELIMITER

- name: Set results output
id: results
uses: actions/github-script@v8
with:
script: |
const filings = ${{ steps.file.outputs.filings || '""' }} || [];
const fixings = ${{ steps.fix.outputs.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;
}
shell: bash
run: |
node << 'NODE_SCRIPT'
const fs = require('fs');
const path = require('path');
const runnerTemp = process.env.RUNNER_TEMP;
const filings = JSON.parse(fs.readFileSync(path.join(runnerTemp, 'filings.json'), 'utf8')) || [];
const fixings = JSON.parse(fs.readFileSync(path.join(runnerTemp, 'fixings.json'), 'utf8')) || [];
const fixingsByIssueUrl = fixings.reduce((acc, fixing) => {
if (fixing.issue && fixing.issue.url) acc[fixing.issue.url] = fixing;
return acc;
}, {});
for (const result of filings) {
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)}`);
}
const resultsPath = path.join(process.env.GITHUB_WORKSPACE, 'scanner-results.json');
fs.writeFileSync(resultsPath, JSON.stringify(filings));
NODE_SCRIPT

RESULTS_FILE="$GITHUB_WORKSPACE/scanner-results.json"

# Set results output (backward compat)
{
echo 'results<<__RESULTS_OUTPUT_DELIMITER__'
cat "$RESULTS_FILE"
echo
echo '__RESULTS_OUTPUT_DELIMITER__'
} >> "$GITHUB_OUTPUT"

# Set results_file output
echo "results_file=$RESULTS_FILE" >> "$GITHUB_OUTPUT"
Copy link
Copy Markdown
Contributor

@JoyceZhu JoyceZhu Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this always execute, even if results_file doesn't get configured in the YAML file?

Copy link
Copy Markdown
Contributor Author

@lindseywild lindseywild Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it always executes; the results_file output is just set unconditionally on the action, and consumers only use it if they reference steps.<id>.outputs.results_file. If they don't reference it, it's ignored.

- if: ${{ inputs.include_screenshots == 'true' }}
name: Save screenshots
uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/gh-cache/save
with:
path: .screenshots
token: ${{ inputs.token }}
- name: Copy results to cache path
shell: bash
run: |
mkdir -p "$(dirname '${{ inputs.cache_key }}')"
cp "$GITHUB_WORKSPACE/scanner-results.json" "${{ inputs.cache_key }}"

- name: Save cached results
uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/gh-cache/cache
uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/gh-cache/save
with:
key: ${{ inputs.cache_key }}
value: ${{ steps.results.outputs.results }}
path: ${{ inputs.cache_key }}
token: ${{ inputs.token }}

branding:
Expand Down
Loading