Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- github-actions
- Ambito
- ci-cd, documentation
Direzione di ricerca
Esamina prima action.yml e la configurazione di cache_key del workflow, quindi individua dove sono documentati i requisiti per la prima esecuzione. Documenta la creazione del branch gh-cache e del file di cache corrispondente, e verifica che l'output del report gestisca le virgolette HTML senza causare l'uscita del workflow con il codice 2.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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"
- Lingua principale
- TypeScript
- Stelle
- 374
- Fork
- 42
- Merge medio
- 1g 13h
- PR unite (30g)
- 7
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/accessibility-scanner
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/accessibility-scanner#264 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
github/accessibility-scanner#260 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 50/100
github/accessibility-scanner#259 ·
-
Configurable issue labels Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 58/100
github/accessibility-scanner#245 ·
-
Sitemap Support Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
github/accessibility-scanner#244 ·
Tutte le issue di github/accessibility-scanner
Issue simili
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Mend: dependency security vulnerability untriaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100