Explain that workflows that submit sarif probably shouldn't fail
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 76/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- github-actions
- Domínio
- documentation
Direção de pesquisa
Comece pela seção “Uploading code scanning data to GitHub” no artigo vinculado sobre configuração avançada; em seguida, revise a documentação vinculada sobre upload de SARIF e o contexto da upload-sarif action. Atualize as orientações para que os leitores entendam o comportamento esperado do exit-code em workflows que enviam SARIF e verifique se a explicação resultante corresponde ao comportamento documentado do workflow.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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:
- Linguagem predominante
- TypeScript
- Estrelas
- 20.9k
- Forks
- 68.8k
- Merge médio
- 12h 41min
- PRs com merge (30d)
- 120
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de github/docs
-
triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 95/100
-
content
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
-
localization
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 72/100
-
content localization
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
content localization
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
Todas as issues de github/docs
Issues semelhantes
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
-
Crush Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
ElementsProject/cln-application#167 · 1 comentário · 1 reação ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Quantco/pnpm-licenses#17 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100