注: この機能を使うには、サイト管理者が の code scanning を有効にする必要があります。 コードをスキャンするためにGitHub Actionsを使いなら、サイト管理者はGitHub Actionsの有効化と、必要なインフラストラクチャのセットアップもしなければなりません。 詳細については、「アプライアンスでの code scanning の構成」を参照してく� さい。
code scanningのセットアップについて
リポジトリでのcode scanningのセットアップには、様々なツールを使うことができます。 詳細については、「リポジトリのcode scanning の設定」を参照してく� さい。
利用できるログと診断情� �は、リポジトリ中でのcode scanningの利用方法によります。 使用しているcode scanningの種類を確認するには、リポジトリの [セキュリティ] タブで、アラート一覧の [ツール] ドロップダウン メニューを使用します。 詳細については、「リポジトリの code scanning アラートの管理」を参照してく� さい。
分析と診断情� �について
code scanningの実行に対する分析と診断情� �は、GitHub上のCodeQL分析を使用して見ることができます。
アラート一覧の上部にあるヘッダーに、最新の分析に関する 分析 情� �が表示されます。 詳細については、「リポジトリの Code Scanning アラートの管理」を参照してく� さい。
診断 情� �は [アクション] ワークフロー ログに表示され、概要メトリックと抽出診断からなります。 GitHub の code scanning ログへのアクセスの詳細については、以下の「code scanningからのログ出力の表示」を参照してく� さい。
GitHubの外部でCodeQL CLIを使っているなら、診断情� �はデータベース分析の間に生成された出力中に示されます。 この情� �は、code scanningの結果とともにGitHubにアップロードするSARIF結果ファイル中にも含まれています。
CodeQL CLI の詳細については、「CI システ� での CodeQL CLI の構成」を参照してく� さい。
サマリメトリクスについて
サマリのメトリクスには以下が含まれます。
- CodeQLデータベースの作成と抽出前のコードベース中のコードの行数(ベースラインとして使われます)
- 外部ライブラリと自動生成されたファイルを含む、コードから抽出されたCodeQLデータベース中のコードの行数
- 自動生成されたファイルと外部ライブラリを除く、CodeQLデータベース中のコードの行数
CodeQLソースコード抽出診断について
抽出診断は分析の間に見られたファイルのみをカバーし、以下のメトリクスを含みます。
- 分析に成功したファイル数
- データベースの作成中に抽出エラーを生成したファイル数
- データベースの作成中に抽出の警告を生成したファイル数
code scanning からログ出力を表示する
このセクションは、GitHub Actionsを使って実行されるcode scanning(CodeQLあるいはサードパーティ)に適用されます。
リポジトリでcode scanningをセットアップしたら、アクションが実行されるとその出力を見ることができます。
-
リポジトリ名の下の [Actions] (アクション) をクリックします。
code scanning ワークフローを実行するためのエントリを含むリストが表示されます。 エントリのテキストは、コミットメッセージに付けるタイトルです。
-
code scanning ワークフローのエントリをクリックします。
-
左側のジョブ名をクリックします。 たとえば、 [分析 (言語)] です。
-
このワークフローの実行時にアクションから出力されるログを確認します。
-
すべてのジョブが完了すると、確認されたすべての code scanning アラートの詳細を表示できます。 詳細については、「リポジトリの code scanning アラートの管理」を参照してく� さい。
注釈: code scanning ワークフローを追� するための pull request をリポジトリに発行すると、その pull request からのアラートは、その pull request がマージされるまで Code scanning ページに直接表示されません。 アラートが見つかった� �合は、pull request がマージされる前に、Code scanning ページのバナーにある [n のアラートを検出] リンクをクリックして表示できます。