Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

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

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

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"
Lenguaje dominante
TypeScript
Estrellas
374
Forks
42
Merge medio
1 d 13 h
PR fusionados (30 d)
7

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/accessibility-scanner

Todos los issues de github/accessibility-scanner

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.