ツールの状態ページについて

メモ

この機能を使用するには、サイト管理者が code scanning を有効にする必要があります。詳しくは、「アプライアンス用コードスキャンの構成」をご覧ください。

Enterprise の所有者が Enterprise レベルで GitHub Code Security ポリシーを設定している場合、code scanning を有効または無効にできない場合があります。詳しくは、「エンタープライズのコードセキュリティと分析のためのポリシーの適用」をご覧ください。

ツールの状態ページとは

ツールの状態ページには、使用している code scanning ツールすべての情報が表示されます。code scanning が期待どおりに動作しない場合、このページは問題のデバッグを開始するのに適したポイントとなります。

メモ

ツールの状態ページには、組織レベルではなく、既定のブランチのリポジトリレベルでのみツールの状態が表示されます。

ツールの状態インジケーター

ツールの状態ページには、次の 3 つの状態のいずれかが表示されます。

        **すべての構成が機能しています**:すべてのツールが想定どおりに動作しています

        **一部の構成には注意が必要**です。一部のツールには警告や重大でない問題があります

        **一部の構成が機能しない**: 1 つ以上のツールに重大なエラーがある

利用可能な情報

すべての code scanning ツールに対して

構成状態と健康状態
スキャンのスケジュール設定
最初と最新のスキャン時間
スキャンで使用されるルール

CodeQL などの統合ツールの場合

上記の情報に加えて、統合ツールのツールの状態ページには、次の詳細が記載されています。

プログラミング言語別のファイルカバレッジの割合
各セットアップの種類の構成の詳細
特定のエラーメッセージ
分析されたファイルのダウンロード可能な CSV レポート
使用されるルールとアラートの数のダウンロード可能なリスト

スキャンされるファイルを CodeQL で定義する方法

CodeQL は、そのファイル内のコード行が処理された場合に、ファイルをスキャン済みとして報告します。

解釈された言語

        **既定のセットアップ**: スキャンされたファイルには、言語 CodeQL が分析できるすべてのソース コード ファイルが含まれます

        **詳細設定**: `paths` と `paths-ignore` を使用して、スキャンするファイルを定義できます。 「[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)」を参照してください。

コンパイル済み言語

ツールの状態ページは、自動ビルドまたは手動ビルドステップを実行する前に存在するファイルを報告します。ビルドプロセス中に生成されたファイルは表示されません。「コンパイル済み言語の CodeQL コードスキャン」を参照してください。

カバレッジの計算

ファイルカバレッジの割合は、 paths および paths-ignore 構成プロパティによって除外されるすべてのファイルを考慮します。

ファイルカバレッジパーセンテージについて

ファイルカバレッジの割合を使用して、分析をデバッグして改善します。

          **[High percentage (高い割合)]**: Code scanning は、その言語で期待どおりに動作しています

        **低い割合**: 診断出力を確認します。 「[AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected)」を参照してください

        **ゼロパーセンテージ**: 現在分析されていない言語のコードがある可能性があります。 これらの言語を含むようにセットアップを更新します。 「[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed)」を参照してください

メモ

詳細設定と既定のセットアップの両方を設定した場合、ツールの状態ページには既定のセットアップのみが表示されます。

トラブルシューティング機能

ツールの状態ページは、次の方法で問題のトラブルシューティングを行うのに役立ちます。

        **エラー メッセージ**: 推奨されるアクションでツールが期待どおりに動作しない理由について説明します

        **ファイル カバレッジ データ**: 分析対象のファイルと言語を示します

        **構成の詳細**: 各分析実行に関する情報を表示します

        **ダウンロード可能なレポート**: CSV レポートに詳細なファイルとルールの情報を提供します

詳細については、次を参照してください。

        [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)

この機能を使用できるユーザーについて

この記事で