デプロイメントのレビュー

レビュー待ちのジョブを承認もしくは拒否できます。

この機能を使用できるユーザーについて

環境、環境シークレット、およびデプロイ保護ルールは、現在のすべての GitHub プランのパブリック リポジトリで使用できます。 ブロンズ、シルバー、ゴールドなどの従来のプランでは使用できません。 プライベートまたは内部リポジトリ内の環境、環境のシークレット、デプロイ ブランチにアクセスするには、GitHub Pro、GitHub Team または GitHub Enterprise を使う必要があります。 GitHub Free プラン、GitHub Pro プラン、または GitHub Team プランを使用している場合、待機タイマーや必須のレビュー担当者など、他のデプロイ保護ルールはパブリック リポジトリでのみ使用できます。

この記事の内容

ワークフローで必須のレビューについて

必須のレビュー担当者が設定された環境を参照するジョブは、開始前に承認を待ちます。 承認を待っている間のジョブは、ステータスが"Waiting"になります。 30 日以内に承認されないジョブは、自動的に失敗します。

環境と必要な承認について詳しくは、「デプロイに環境の使用」を参照してください。 REST API を使ってデプロイを確認する方法については、「ワークフロー実行の REST API エンドポイント」を参照してください。

ジョブの承認もしくは拒否

  1. レビューを必要とするワークフローの実行へ移動してください。 ワークフロー実行への移動について詳しくは、「ワークフロー実行の履歴を表示する」をご覧ください。
  2. 実行にレビューが必要な場合は、レビュー要求の通知が表示されます。 通知で、 [Review deployments] (デプロイのレビュー) をクリックします。
  3. 承認もしくは拒否するジョブ環境を選択してください。 コメントを残すこともできます。
  4. 承認もしくは拒否してください。
    • ジョブを承認するには、 [承認してデプロイ] をクリックします。 ジョブが承認されると（そして他のデプロイ保護規則をパスすれば）、ジョブは進行します。 この時点で、ジョブは環境に保存されている任意のシークレットにアクセスできます。
    • ジョブを拒否するには、 [拒否] をクリックします。 ジョブが拒否されると、ワークフローは失敗します。

注: ターゲット環境が展開の自己承認を禁止するように構成されている場合、開始したワークフロー実行から展開を承認することはできません。 詳しくは、「デプロイに環境の使用」を参照してください。

デプロイ保護規則

環境にソフトウェアをデプロイできるかどうかを制御するデプロイ保護規則を構成している場合は、それらの規則をバイパスし、環境を参照しているすべての保留中のジョブを強制的に進行させることができます。

注:

  • 管理者が構成された保護規則をバイパスできないように環境が構成されている場合は、デプロイ保護規則をバイパスすることはできません。 詳しくは、「デプロイに環境の使用」を参照してください。
  • ワークフローの実行中にデプロイ保護規則をバイパスできるのは、環境を参照しているジョブが "保留中" 状態の場合のみです。
  1. ワークフロー実行に移動します。 ワークフロー実行への移動について詳しくは、「ワークフロー実行の履歴を表示する」をご覧ください。
  2. [Deployment protection rules] (デプロイ保護規則) の右側にある [Start all waiting jobs] (すべての待機ジョブを開始する) をクリックします。
    [Deployment protection rules] (デプロイ保護規則) セクションのスクリーンショット。[Start all waiting jobs] (すべての待機ジョブを開始する) ボタンがオレンジ色の枠線で囲まれています
  3. ポップアップ ウィンドウで、デプロイ保護規則をバイパスする環境を選択します。
  4. [Leave a comment] (コメントを残す) で、デプロイ保護規則をバイパスするための説明を入力します。
  5. [I understand the consequences, start deploying] (結果を理解し、デプロイを開始します) をクリックします。