Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- github-actions
- Área
- ci-cd, documentation
Línea de trabajo
Revisa primero action.yml y la configuración de cache_key del workflow; después, identifica dónde están documentados los requisitos de la primera ejecución. Documenta la creación de la rama gh-cache y del archivo de caché correspondiente, y verifica que la salida del informe gestione las comillas HTML sin hacer que el workflow termine con el código 2.
Escrito por el modelo de indexación a partir del texto del issue.
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-cachedoes not exist
Creating a branch named gh-cache resolved this.
2️⃣ Missing cache file matching cache_key
Next error on report:
cache-key-valuenot 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"
- Lenguaje dominante
- TypeScript
- Estrellas
- 374
- Forks
- 42
- Merge medio
- 1 d 13 h
- PR fusionados (30 d)
- 7
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/accessibility-scanner
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/accessibility-scanner#264 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
github/accessibility-scanner#260 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 50/100
github/accessibility-scanner#259 ·
-
Configurable issue labels Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 58/100
github/accessibility-scanner#245 ·
-
Sitemap Support Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
github/accessibility-scanner#244 ·
Todos los issues de github/accessibility-scanner
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
bug v2
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
modelcontextprotocol/inspector#2458 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
carbon-design-system/ibm-products#9907 ·