-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding more information about the behaviour of manual interventions (#…
…2580) Adding more information about the behaviour of manual interventions
- Loading branch information
1 parent
ec6ef77
commit e67bc49
Showing
1 changed file
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2023-01-01 | ||
modDate: 2024-08-27 | ||
modDate: 2024-12-02 | ||
title: Manual intervention and approval step | ||
icon: fa-solid fa-check | ||
description: Manual intervention and approvals allow a human to review, approve, or sign off on deployments. | ||
|
@@ -17,6 +17,12 @@ While fully automated deployment is a great goal, there are times when a human n | |
|
||
The **Manual intervention step** is a step that can be added to deployment processes to pause the deployment to wait for a member of a specified team to either allow the deployment to proceed or to be aborted. | ||
|
||
:::div{.hint} | ||
Manual interventions result in either a success or failure outcome based on the user’s input. Subsequent steps evaluate this outcome according to their run conditions. By default, the run condition is set to "Success: only run when previous steps succeed." This means manual interventions can prevent these steps from executing, causing the deployment to fail. | ||
|
||
However, if "Always Run" is selected for subsequent steps, they will proceed regardless of the manual intervention outcome. For steps with the condition "Variable: only run when the variable expression is true," the manual intervention's outcome must be included in the variable expression to determine whether the step should run. | ||
::: | ||
|
||
[Getting Started - Manual Intervention](https://www.youtube.com/watch?v=ePQjCClGfZQ) | ||
|
||
## Add a manual intervention step | ||
|
@@ -73,6 +79,17 @@ When a manual step is completed, details of the interruption are saved as variab | |
| `Octopus.Action[Step Name].Output.Manual.ResponsibleUser.DisplayName` | The display name of the user who submitted the interruption form | *Jamie Jones* | | ||
| `Octopus.Action[Step Name].Output.Manual.ResponsibleUser.EmailAddress` | The email address of the user who submitted the interruption form | *[email protected]* | | ||
|
||
## Evaluating manual intervention output in following steps | ||
If you want to control subsequent steps based on the outcome of the manual intervention step, you can use "Variable: only run when the variable expression is true", and use the `Octopus.Deployment.Error` variable as the conditional. For example: | ||
|
||
``` | ||
#{unless Octopus.Deployment.Error}RESULT IF MANUAL INTERVENTION PROCEEDED{/unless} | ||
``` | ||
or | ||
``` | ||
#{if Octopus.Deployment.Error}RESULT IF MANUAL INTERVENTION WAS ABORTED{/if} | ||
``` | ||
|
||
## Learn more | ||
|
||
- [Advanced manual approvals](/docs/deployments/databases/common-patterns/manual-approvals) | ||
|