コードスキャンのマージ保護を設定します

code scanning マージ保護にルールセットを使用する方法について

Note

ルールセットを使用したマージ保護は、ステータスチェックと関係ありません。ステータスチェックの詳細については、「ステータスチェックについて」を参照してください。
ルールセットによるマージ保護は、既定のセットアップで分析されたマージキューグループまたは Dependabot プル要求には適用されません。

ルールセットを使用すると、次のいずれかの条件が満たされたときに pull request がマージされないようにできます。

必要なツールで、ルールセットで定義している重大度の code scanning アラートが見つかりました。
必要な code scanning ツールはまだ分析中です。
必要な code scanning ツールはリポジトリ用に構成されていません。

Pull request をマージする前にコードの分析を確実に完了しておきたい場合、通常は、長期間存続する機能ブランチをターゲットとするルールセットを使うようにします。

code scanning 規則を構成しても、code scanning は自動的に有効になりません。コードスキャンを有効にする方法の詳細については、「コードスキャンの既定セットアップの構成」を参照してください。

code scanningの詳細については、「Code scanningアラートについて」を参照してください。

マージ保護は、リポジトリ level で、および既定のセットアップまたは高度なセットアップで構成されたリポジトリに対して、ルールセットを使用してマージの保護を設定できます。 REST API を使用して、ルールセットを使用してマージ保護の設定もできます。

ルールセットの詳細については、「ルールセットについて」を参照してください。

リポジトリのマージ保護規則セットの作成

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。
「新しいルールセット」をクリックします。
ブランチを対象とするルールセットを作成するには、 [新しいブランチルールセット] をクリックします。
[ルールセット名] に、ルールセットの名前を入力します。
必要に応じて、既定の適用ステータスを変更するには、 [無効] をクリックし、新しい適用ステータスを選択します。適用ステータスの詳しい情報については、「ルールセットについて」を参照してください。
[ブランチ保護] で、[Require code scanning results] を選択します。
[Required tools and alert thresholds] で、[ Add tool] をクリックし、ドロップダウンで code scanning ツールを選びます。たとえば、"CodeQL"。
code scanning ツールの名前の隣
- [アラート] をクリックし、[なし]、[エラー]、[エラーと警告]、または [すべて] のいずれかを選択します。
- [セキュリティアラート] をクリックし、[なし]、[重大]、[高以上]、[中以上]、または [すべて] のいずれかを選択します。