Explain that workflows that submit sarif probably shouldn't fail

Geschlossen Anfängerfreundlich

#38,062 erstellt am 06.5.2025 22 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 2/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 76/100

Issue-Typ: Dokumentation
Klarheit: Klar beschrieben
Aktivitätsstatus: Aktiv
Tech-Stack: github-actions
Bereich: documentation

Rechercherichtung

Beginnen Sie mit dem Abschnitt “Uploading code scanning data to GitHub” im verlinkten Artikel zur erweiterten Einrichtung. Lesen Sie anschließend die verlinkte Dokumentation zum SARIF-Upload sowie den Kontext der upload-sarif action. Aktualisieren Sie die Anleitung, damit Leser das erwartete exit-code-Verhalten für Workflows verstehen, die SARIF übermitteln, und überprüfen Sie, dass die resultierende Erklärung mit dem dokumentierten Workflow-Verhalten übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

code security content needs SME

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?

https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning

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:

Vorherrschende Sprache: TypeScript
Sterne: 20.9k
Forks: 68.8k
Ø Merge: 12 Std. 41 Min.
Gemergte PRs (30 T.): 120

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/docs

Fix stale Edit mode anchor in Copilot Chat in an IDE Offen

triage

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100

github/docs#46060 · Erstellt am 24.9.2026
Update OIDC authentication section for clarity Offen

content

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100

github/docs#46032 · 1 Kommentar · Erstellt am 23.9.2026
Simplified Chinese GitHub Mobile article displays an untranslated English body Offen

localization

Schwierigkeit 2/5 1-2 Tage Anfängerfreundlichkeit 72/100

github/docs#45949 · 1 Kommentar · Erstellt am 18.9.2026
[ja] Broken table rendering on "GitHub language support" Offen

content localization

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

github/docs#45858 · 2 Kommentare · 1 Reaktion · Erstellt am 12.9.2026
Wrong translation in French version of the "Manually running a workflow" article Offen

content localization

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100

github/docs#45773 · 2 Kommentare · Erstellt am 06.9.2026

Alle Issues in github/docs