Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance

Open
#37 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions
Domain
ci-cd, documentation

Research direction

Review action.yml and the workflow's cache_key setup first, then identify where first-run requirements are documented. Document creation of the gh-cache branch and matching cache file, and verify the report output handles HTML quotation marks without causing the workflow to exit with code 2.

Written by the indexing model from the issue text.

Description

awaiting-reporter

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"
Dominant language
TypeScript
Stars
374
Forks
42
Avg merge
1d 9h
Merged PRs (30d)
10

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/accessibility-scanner

All issues in github/accessibility-scanner

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.