カスタムデプロイ保護規則の構成

注: カスタム展開保護ルールは、現在ベータ段階であり、変更される可能性があります。

カスタムデプロイ保護規則について

カスタムデプロイ保護規則は GitHub Apps を利用しています。デプロイ保護規則が構成され、リポジトリにインストールされると、リポジトリ内の任意の環境に対して有効にすることができます。

ある環境でカスタムデプロイ保護規則を有効にすると、ワークフロー手順がその環境を対象にするたびに、デプロイ保護規則が自動的に実行されます。デプロイの環境の対象設定については、「デプロイに環境の使用」を参照してください。

カスタム展開保護ルールがトリガーされると、タイムアウトしてワークフロージョブが失敗するまで、Webhook イベントの応答を最大 30 日間待機します。

独自のカスタムデプロイ保護規則の作成については、「カスタムデプロイ保護規則の作成」を参照してください。

注: 任意の数の GitHub Apps ベースのデプロイ保護規則をリポジトリにインストールできます。ただし、どの環境でも、同時に有効にできるデプロイ保護規則は最大 6 つです。

独自のカスタムデプロイ保護規則を作成することや、既存のカスタムデプロイ保護規則を使うことができます。

デプロイ保護規則の公式パートナー実装の一覧を次に示します。

Datadog: Datadog モニターを使って GitHub Actions デプロイワークフローに保護規則を適用できます。詳細については、Datadog ドキュメントの「Datadog Monitors を使った GitHub Actions デプロイの制御」を参照してください。
Honeycomb: Honeycomb に送信するデータに基づいて、デプロイを拒否または承認するしきい値を定義できます。詳細については、GitHub Marketplace の「Honeycomb アプリ」を参照してください。
New Relic: 詳細については、GitHub Marketplace の「New Relic アプリ」を参照してください。
NCM NodeSource: 詳細については、GitHub Marketplace の「NCM NodeSource アプリ」を参照してください。
Sentry: 詳細については、GitHub Marketplace の「Sentry Deployment Gate アプリ」を参照してください。
ServiceNow: 詳細については、ServiceNow ドキュメントの「GitHub integration with DevOps Change Velocity」を参照してください。

カスタムデプロイ保護規則をリポジトリ内のすべての環境で使用できるようにするには、まずリポジトリにカスタムデプロイ保護規則をインストールする必要があります。詳しくは、「独自の GitHub App のインストール」を参照してください。

カスタムデプロイ保護規則をリポジトリにインストールした後、規則を適用する各環境で有効にする必要があります。

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーで、 [環境] をクリックします。
構成する環境を選びます。
[デプロイ保護規則] で、その環境に対して有効にする各カスタムデプロイ保護規則の横にあるボックスをオンにします。
[保護ルールの保存] をクリックします。

カスタムデプロイ保護規則を環境に対して有効にすると、ワークフローがその環境を参照するジョブに到達するたびに自動的に実行されます。デプロイの詳細を確認すると、デプロイの承認または拒否の結果が表示されます。詳しくは、「デプロイメントのレビュー」を参照してください。