Explain that workflows that submit sarif probably shouldn't fail
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 76/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- github-actions
- Domaine
- documentation
Piste de recherche
Commencez par la section “Uploading code scanning data to GitHub” de l’article lié sur la configuration avancée, puis consultez la documentation liée sur l’importation de SARIF ainsi que le contexte de la upload-sarif action. Mettez à jour les instructions afin que les lecteurs comprennent le comportement attendu de l’exit-code pour les workflows qui soumettent du SARIF, et vérifiez que l’explication obtenue correspond au comportement documenté du workflow.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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:
- Langage dominant
- TypeScript
- Étoiles
- 20.9k
- Forks
- 68.8k
- Merge moyen
- 12 h 41 min
- PR mergées (30 j)
- 120
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/docs
-
content triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
-
localization
Difficulté 2/5 1-2 jours Accessibilité débutants 72/100
-
content localization
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
content localization
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
-
content dependabot needs SME
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Toutes les issues de github/docs
Issues similaires
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
Crush Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
ElementsProject/cln-application#167 · 1 commentaire · 1 réaction ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100