Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Explain that workflows that submit sarif probably shouldn't fail

已關閉 適合新手
#38,062 22 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
76/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
github-actions
領域
documentation

研究方向

從連結的進階設定文章中的「Uploading code scanning data to GitHub」章節開始,接著檢視連結的 SARIF 上傳文件和 upload-sarif action 脈絡。更新指南,讓讀者了解提交 SARIF 的工作流程預期的 exit-code 行為,並確認最後的說明與文件所描述的工作流程行為一致。

由索引模型根據 Issue 內容生成。

描述

code security content needs SME
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:

Image

And the status link goes to:
Image

主要語言
TypeScript
星號
20.9k
分支
68.8k
平均合併
12 小時 41 分鐘
30 天內合併 PR
120

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

github/docs 的其他 Issue

查看 github/docs 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。