Skip to main content

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

ツールの状態ページでは、リポジトリ内のcode scanning ツールの正常性とパフォーマンスを可視化できます。

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

書き込み アクセスを持つユーザー

Code scanning は、次のリポジトリの種類で使用できます。

  • GitHub.com 上のパブリックリポジトリ
  • GitHub Team、GitHub Enterprise Cloud、または GitHub Enterprise Server 上の組織所有リポジトリ。 GitHub Code Security が 有効になっています。

ツールの状態ページ とは。

ツールの状態ページには、すべてのcode scanning ツールに関する情報が表示され、code scanningが期待どおりに動作しない場合の問題をデバッグするための出発点として適しています。

メモ

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

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

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

  • すべての構成が機能しています:すべてのツールが想定どおりに動作しています
  • 一部の構成には注意が必要です。一部のツールには警告や重大でない問題があります
  • 一部の構成が機能しない: 1 つ以上のツールに重大なエラーがある

利用可能な情報

すべての code scanning ツール

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

次のような統合ツールの場合 CodeQL

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

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

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

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

解釈された言語

  • 既定のセットアップ: スキャンされたファイルには、分析できる言語のすべてのソース コード ファイル CodeQL 含まれます
  • 詳細設定: pathspaths-ignore を使用して、スキャンするファイルを定義できます。 「CodeQL を使用したコード スキャン」を参照してください。

コンパイル済み言語

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

カバレッジの計算

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

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

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

メモ

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

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

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

  • エラー メッセージ: 推奨されるアクションでツールが期待どおりに動作しない理由について説明します
  • ファイル カバレッジ データ: 分析対象のファイルと言語を示します
  • 構成の詳細: 各分析実行に関する情報を表示します
  • ダウンロード可能なレポート: CSV レポートに詳細なファイルとルールの情報を提供します

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