Skip to main content

code scanning のリポジトリのプロパティ

リポジトリのプロパティを使って、code scanning をニーズに応じて調整できます。

前提条件

ここで説明するリポジトリのプロパティが目的どおりに機能するようにするには、code scanning を設定する必要があります。 「コード スキャンのセットアップの種類について」を参照してください。

code scanning に影響するリポジトリ プロパティは、組織に対して手動で作成する必要があります。 その後、組織全体に適用される値を設定するか、リポジトリごとに異なる方法で構成することができます。 「Organization 内リポジトリのカスタム プロパティの管理」を参照してください。

code scanning でサポートされているリポジトリ プロパティ

一部の code scanning 機能は、リポジトリのプロパティを使用して構成できます。 組織では、リポジトリプロパティを使用して、すべてのリポジトリと個々のリポジトリの両方に構成を適用できます。 code scanning がリポジトリ プロパティを使用してカスタマイズされている場合、カスタマイズはすべてのセットアップの種類に適用されます。

構成時に code scanning 分析に影響を与える、設定できるリポジトリ プロパティの概要を次に示します。

名前タイプ
github-codeql-extra-queriesテキスト
github-codeql-disable-overlaytrue または false
github-codeql-file-coverage-on-prstrue または false

メモ

サポートされているリポジトリのプロパティは、code scanning 分析で使用される github/codeql-action のバージョンによって異なります。 code scanning の詳細設定では、ワークフローが最新の大きなバージョンを参照されていることを確認してください。 Code scanning の既定のセットアップでは、最新バージョンが自動的に使用されます。

分析のカスタマイズ

          `github-codeql-extra-queries` プロパティを使用すると、実行する必要がある追加のクエリを構成できます。 これは、個々のワークフローを変更したり、詳細設定に切り替えたりしなくても、組織内のすべての関連する分析にクエリを追加する場合に便利です。 これは、`queries` の[](https://github.com/github/codeql-action/)入力と同じ値を受け入れます。 「[AUTOTITLE](/code-security/reference/code-scanning/workflow-configuration-options)」を参照してください。

機能の有効化または無効化

          `github-codeql-disable-overlay` プロパティを `true` に設定することで、改善された増分分析を無効にすることができます。 これは、ハードウェア要件の増加により、増分分析の改善が失敗した場合に役立つ場合があります。

プル要求の分析では、ファイル カバレッジ情報は計算されません。 プル要求のファイル カバレッジ情報を有効にする場合は、 github-codeql-file-coverage-on-prs プロパティを true に設定できます。