github / github/accessibility-scanner
Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance
- Dominant language
- TypeScript
- Stars
- 369
- Forks
- 40
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 10
Description
Great tool! It works for me now. However, I ran into a few undocumented setup issues during the first run that caused the workflow to exit with code 2.
**1️⃣ Missing `gh-cache` branch**
The first run failed with:
> Branch `gh-cache` does not exist
Creating a branch named `gh-cache` resolved this.
**2️⃣ Missing cache file matching `cache_key`**
Next error on report:
> `cache-key-value` not found in cache
Creating and pushing an empty file onto the `gh-cache` branch whose name matches the `cache_key` value in the workflow YAML fixed this issue.
**3️⃣ JSON escaping issue in action.yml file in codebase:**
Final error in report:
The line `echo "issues=$issues" >> "$GITHUB_OUTPUT"` fails whenever HTML contains quotations. This likely happens due to the line trying to echo out unescaped quotes.
Proposed fix:
```
issues_escaped=$(echo "$issues" | jq -c . | sed 's/%/%25/g; s/\r/%0D/g; s/\n/%0A/g')
echo "issues=$issues_escaped" >> "$GITHUB_OUTPUT"
```
Contributor guide
Assessment
This issue has not been assessed yet.