Explain that workflows that submit sarif probably shouldn't fail
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 76/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- github-actions
調査の方向性
リンク先の高度なセットアップに関する記事の「Uploading code scanning data to GitHub」セクションから始め、リンク先のSARIFアップロードに関するドキュメントとupload-sarif actionのコンテキストを確認します。SARIFを送信するワークフローで想定されるexit-codeの動作を読者が理解できるようにガイダンスを更新し、その結果の説明がドキュメントに記載されたワークフローの動作と一致することを確認します。
索引モデルが issue の本文から書いたものです。
説明
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:
- 主要言語
- TypeScript
- スター
- 20.9k
- フォーク
- 68.8k
- 平均マージ
- 12時間 41分
- マージ済み PR（30日）
- 120
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/docs のほかの issue
-
content triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
localization
難易度 2/5 1〜2日 初心者へのやさしさ 72/100
-
content localization
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
content localization
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
content dependabot needs SME
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
似ている issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Crush オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ElementsProject/cln-application#167 · コメント 1 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Quantco/pnpm-licenses#17 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100