前提条件
ここで説明するリポジトリプロパティが有効にするには、 code scanningを設定する必要があります。 「コード スキャンのセットアップの種類について」を参照してください。
code scanningに影響するリポジトリ プロパティは、組織用に手動で作成する必要があります。 その後、組織全体に適用される値を設定するか、リポジトリごとに異なる方法で構成することができます。 「Organization 内リポジトリのカスタム プロパティの管理」を参照してください。
変更を適用する前にテストする
リポジトリ プロパティを通じて適用される構成が、組織全体にロールアウトする前に目的の効果を持っていることをテストできます。 リポジトリのプロパティは、個々のリポジトリの特定の値に設定できます。 リポジトリ プロパティを初めて構成する場合は、組織用に作成しますが、値に設定しないでください。 代わりに、変更を最初に検証できる特定のテスト リポジトリの値に設定します。 テスト リポジトリで検証したら、組織全体または目的のリポジトリの値を設定できます。
サポートされているリポジトリ プロパティの値を変更する場合は、同じ方法を使用できます。 テスト リポジトリのリポジトリ プロパティの値をオーバーライドまたは設定し、変更を検証してから、組織または他のリポジトリにロールアウトします。
サポートされているリポジトリのプロパティ code scanning
一部の code scanning 機能は、リポジトリのプロパティを使用して構成できます。 組織では、リポジトリプロパティを使用して、すべてのリポジトリと個々のリポジトリの両方に構成を適用できます。 リポジトリのプロパティを使用して code scanning をカスタマイズした場合、カスタマイズはすべてのセットアップの種類に適用されます。
構成時の code scanning 分析に影響を与える、設定できるリポジトリ プロパティの概要を次に示します。
| 名前 | タイプ |
|---|---|
github-codeql-extra-queries | テキスト |
github-codeql-disable-overlay | true または false |
github-codeql-file-coverage-on-prs | true または false |
メモ
サポートされているリポジトリのプロパティは、分析で使用される code scanning のバージョンによって異なります。 詳細設定 code scanning 場合は、ワークフローが最新のメジャー バージョンを参照していることを確認します。 Code scanning 既定のセットアップでは、最新バージョンが自動的に使用されます。 GitHub Enterprise Serverを実行しているサーバーがインターネットに接続されていない場合は、CodeQLアクション同期ツールを使用する必要があります。 「AUTOTITLE」を参照してください。
分析のカスタマイズ
github-codeql-extra-queries プロパティを使用すると、実行する必要がある追加のクエリを構成できます。 これは、個々のワークフローを変更したり、詳細設定に切り替えたりしなくても、組織内のすべての関連する分析にクエリを追加する場合に便利です。 これは、queries の入力と同じ値を受け入れます。 「コード スキャンのワークフロー構成オプション」を参照してください。
機能の有効化または無効化
github-codeql-disable-overlay プロパティを true に設定することで、改善された増分分析を無効にすることができます。 これは、ハードウェア要件の増加により、増分分析の改善が失敗した場合に役立つ場合があります。
プル要求の分析では、ファイル カバレッジ情報は計算されません。 プル要求のファイル カバレッジ情報を有効にする場合は、 github-codeql-file-coverage-on-prs プロパティを true に設定できます。