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

前提条件

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

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

変更を適用する前にテストする

リポジトリ プロパティを通じて適用される構成が、組織全体にロールアウトする前に目的の効果を持っていることをテストできます。 リポジトリのプロパティは、個々のリポジトリの特定の値に設定できます。 リポジトリ プロパティを初めて構成する場合は、組織用に作成しますが、値に設定しないでください。 代わりに、変更を最初に検証できる特定のテスト リポジトリの値に設定します。 テスト リポジトリで検証したら、組織全体または目的のリポジトリの値を設定できます。

サポートされているリポジトリ プロパティの値を変更する場合は、同じ方法を使用できます。 テスト リポジトリのリポジトリ プロパティの値をオーバーライドまたは設定し、変更を検証してから、組織または他のリポジトリにロールアウトします。

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

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

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

名前	タイプ
github-codeql-config-file	テキスト
github-codeql-extra-queries	テキスト
github-codeql-disable-overlay	true または false
github-codeql-file-coverage-on-prs	true または false
github-codeql-tools	テキスト

カスタム構成ファイル

github-codeql-config-file プロパティは、構成ファイルのローカル パスまたはリモート パスに設定できます。 このプロパティに使用できる値は、codeql-action/init アクションのconfig-file パラメーターと同じです。 受け入れ可能なパス形式と構成ファイルの可能な内容の詳細については、 AUTOTITLE を参照してください。

github-codeql-config-file プロパティに指定された値は、既定code scanningセットアップとcode scanning詳細設定の両方に適用されます。 高度なセットアップ ワークフローで、codeql-action/init アクションのconfig-file パラメーターの明示的な入力が指定されている場合、その入力はリポジトリ プロパティで構成された値よりも優先されます。 これにより、必要に応じて、高度なワークフローで既定のセットアップ ワークフローに適用される構成とは異なる構成を使用できます。

github-codeql-config-file プロパティを使用して適用されたカスタム構成ファイルは、既定のセットアップcode scanning自動的に生成される構成とマージされます。 Code scanning 既定のセットアップでは、使用する脅威モデルや CodeQL モデル パックなど、ユーザー インターフェイスの一部の分析設定をカスタマイズできます。 これらの選択はマージされた構成に保持されます。既定のセットアップ UI で選択された脅威モデルは、構成ファイルで指定された脅威モデルと組み合わされ、UI で構成されたモデル パックが保持されます。 既定のセットアップで使用可能な構成オプションの詳細については、 コード スキャンのセットアップの種類についてcode scanning 参照してください。

その他の分析のカスタマイズ

github-codeql-extra-queries プロパティを使用すると、実行する必要がある追加のクエリを構成できます。 これは、個々のワークフローを変更したり、詳細設定に切り替えたりしなくても、組織内のすべての関連する分析にクエリを追加する場合に便利です。 これは、queries の入力と同じ値を受け入れます。 「コード スキャンのワークフロー構成オプション」を参照してください。

既定では、 code scanning 分析では、最新リリースバージョンの CodeQL が使用されます。 別のバージョンに切り替えることで解決される特定の問題が発生している場合を除き、通常、これを変更することはお勧めしません。 これを変更する必要がある場合は、 github-codeql-tools プロパティを使用して別のバージョンを指定できます。

高度なセットアップ ワークフローで、codeql-action/init アクションのtools パラメーターの明示的な入力が指定されている場合、その入力はリポジトリ プロパティで構成された値よりも優先されます。 これにより、必要に応じて、高度なワークフローで既定のセットアップ ワークフローに適用される構成とは異なる構成を使用できます。 明示的な tools 入力がある場合でも、リポジトリ プロパティの値を高度なセットアップ ワークフローに適用するには、リポジトリ プロパティの値に ! プレフィックスを追加します。 たとえば、 !nightly では、すべてのワークフローが最新の nightly リリースを使用することを強制します。

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

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

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