Explain that workflows that submit sarif probably shouldn't fail
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 76/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- github-actions
- Ambito
- documentation
Direzione di ricerca
Inizia dalla sezione “Uploading code scanning data to GitHub” nell’articolo collegato sulla configurazione avanzata, quindi esamina la documentazione collegata sul caricamento di SARIF e il contesto della upload-sarif action. Aggiorna le indicazioni in modo che i lettori comprendano il comportamento previsto dell’exit-code per i workflow che inviano SARIF e verifica che la spiegazione risultante corrisponda al comportamento documentato del workflow.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
Uploading code scanning data to GitHub
Says:
GitHub can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the
upload-sarif action. For more information, see Uploading a SARIF file to GitHub.
It doesn't say anything about exit codes for such workflows.
(It doesn't link to the upload-sarif action, which may be for the best as using that will delay workflows by 6 seconds. -- The action is intentionally not listed in the GitHub Marketplace unlike, e.g. checkout.)
Additional information
Normally if you want to prevent a pull request from being merged, you'd have your workflow "fail" triggering an ❌.
But, if you do that for a workflow that submits sarifs (at least using some of the apis, especially the github/codeql-action/upload-sarif), then you'll get:
And the status link goes to:
- Lingua principale
- TypeScript
- Stelle
- 20.9k
- Fork
- 68.8k
- Merge medio
- 12h 41m
- PR unite (30g)
- 120
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/docs
-
content triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
localization
Difficoltà 2/5 1-2 giorni Idoneità per principianti 72/100
-
content localization
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
content localization
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
content dependabot needs SME
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
Issue simili
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Crush Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
ElementsProject/cln-application#167 · 1 commento · 1 reazione ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Quantco/pnpm-licenses#17 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100