github / github/accessibility-scanner

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

Abierto
#37 4 comentarios 0 reacciones 0 asignados Ver en GitHub
awaiting-reporter
Lenguaje dominante
TypeScript
Estrellas
369
Forks
40
Merge medio
1 d 9 h
PR fusionados (30 d)
10

Descripción

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"
```

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.