ワークフロー実行の承認を要求する

ワークフロー実行を続行する前に承認を要求するように設定できます。これを実現するには、ワークフローに承認ゲートを追加する必要があります。承認ゲートは、ユーザーまたはユーザーのセットが CodeCatalyst コンソールで 1 つ以上の承認を送信するまでワークフローを続行できないようにします。すべての承認が行われると、ゲートは「ロック解除」になり、ワークフロー実行を再開できます。

ワークフローで承認ゲートを使用して、開発チーム、運用チーム、リーダーシップチームに、より広範な対象者にデプロイされる前に変更を確認する機会を与えます。

承認ゲートのロックを解除するにはどうすればよいですか？

承認ゲートをロック解除するには、次の条件をすべて満たす必要があります。

• 条件 1: 必要な承認数を送信する必要があります。必要な承認数は設定可能で、各ユーザーは 1 つの承認を送信できます。

• 条件 2: ゲートがタイムアウトする前に、すべての承認を送信する必要があります。ゲートはアクティブ化されてから 14 日後にタイムアウトします。この期間は設定できません。

• 条件 3: ワークフロー実行を拒否するべき人はいません。1 回拒否すると、ワークフローの実行が失敗します。

• 条件 4: (置き換えられた実行モードを使用している場合にのみ適用されます）。実行を後の実行に置き換えないでください。詳細については、「ワークフロー承認は、キューに入れられた実行モード、置き換えられた実行モード、並列実行モードでどのように機能しますか？」を参照してください。

いずれかの条件が満たされない場合、 はワークフロー CodeCatalyst を停止し、実行ステータスを Failed (条件 1 から 3 の場合) または Supersed (条件 4 の場合) に設定します。

「承認」ゲートを使用するタイミング

通常、アプリケーションやその他のリソースを本番サーバーや品質標準を検証する必要がある環境にデプロイするワークフローでは、承認ゲートを使用します。本番環境へのデプロイの前にゲートを配置することで、レビューワーに新しいソフトウェアリビジョンが一般に公開される前に検証する機会を与えることができます。

誰が承認を提供できますか？

プロジェクトのメンバーであり、寄稿者またはプロジェクト管理者ロールを持つユーザーは、承認を行うことができます。プロジェクトのスペースに属するスペース管理者ロールを持つユーザーは、承認を提供することもできます。

注記

Reviewer ロールを持つユーザーは、承認を提供できません。

承認が必要であることをユーザーに通知するにはどうすればよいですか？

承認が必要であることをユーザーに通知するには、以下を実行する必要があります。

• Slack 通知 CodeCatalyst を送信します。詳細については、「承認通知の設定」を参照してください。

• 承認ボタンと拒否ボタンがある CodeCatalyst コンソールのページに移動し、承認者宛ての E メールまたはメッセージングアプリケーションにそのページの URL を貼り付けます。このページに移動する方法の詳細については、「」を参照してくださいワークフロー実行の承認または拒否。

ワークフロー実行の開始を防ぐために「承認」ゲートを使用できますか？

はい、資格があります。詳細については、「ゲートを使用してワークフローの実行を開始できないようにできますか？」を参照してください。

ワークフロー承認は、キューに入れられた実行モード、置き換えられた実行モード、並列実行モードでどのように機能しますか？

キューに入れられた実行モード、置き換えられた実行モード、または並列実行モードを使用する場合、承認ゲートはアクション と同様に機能します。これらの実行モードに慣れるためにキューに入れられた実行モードについて、、置き換えられた実行モードについて、 並列実行モードについてセクションを読むことをお勧めします。基本的な理解ができたら、このセクションに戻り、承認ゲートが存在するときにこれらの実行モードがどのように機能するかを確認してください。

承認ゲートが存在する場合、実行は次のように処理されます。

• キューに入れられた実行モード を使用している場合、実行は、ゲートで現在承認を待っている実行の背後でキューに入れられます。そのゲートがロック解除される (つまり、すべての承認が付与される) と、キュー内の次の実行はゲートに進み、承認を待ちます。このプロセスは、キューに入れられた実行がゲート を介して処理されるのを続行します one-by-one。 はこのプロセスFigure 1を示しています。

• 置き換えられた実行モード を使用している場合、動作はキューに入れられた実行モードと同じですが、 がゲートでキューに蓄積されるのではなく、新しい実行が以前の実行よりも優先されます (引き継がれます）。キューはなく、現在ゲートで承認を待っている実行はキャンセルされ、新しい実行に置き換えられます。 はこのプロセスFigure 2を示しています。

• 並列実行モード を使用している場合、実行は並列で開始され、キュー形式はありません。各実行は、その前に実行がないため、すぐにゲートによって処理されます。 はこのプロセスFigure 3を示しています。

図 1: 「キューに入れられた実行モード」と承認ゲート

図 2：「スーパーステッド実行モード」と承認ゲート

図 3: 「並列実行モード」と承認ゲート

トピック

• 例：「承認」ゲートの設定
• ワークフローへの「承認」ゲートの追加
• 承認通知の設定
• ワークフロー実行の承認または拒否
• 「承認」ゲート YAML 定義