Skip to content

Commit 83e515f

Browse files
committed
add more deployment confirmation docs
1 parent d36690e commit 83e515f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/deployment-confirmation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
## Overview
44

5-
For projects that require the highest level of deployment safety/security, the branch-deploy Action can be configured to require a deployment confirmation before a deployment is allowed to proceed.
5+
For projects that require the highest level of deployment safety/security, the branch-deploy Action can be configured to require a deployment **confirmation** before a deployment is allowed to proceed.
66

7-
This can be considered a "final safety check" before a deployment is allowed to proceed.
7+
This can be considered a "final safety check" before a deployment can continue.
88

99
By using this feature, it is also an extremely effect way to prevent accidental or malicious commits from being deployed without first having one last safety review. This is important for hardening against Actions related [TOCTOU](https://github.com/AdnaneKhan/ActionsTOCTOU) vulnerabilities.
1010

1111
## How it works
1212

1313
When a user invokes a deployment via the `.deploy` (or `.noop`) command, the branch-deploy Action will pause _just_ before the final call to start a deployment by this Action. The Action will then create a new comment on the pull request that invoked the deployment, asking the user to confirm (or reject) the deployment.
1414

15-
This comment will provide the user with a summary of the deployment that is __about__ to be run. The user will then have the opportunity to confirm (with a 👍) or deny (with a 👎) the deployment.
15+
This comment will provide the user with a summary of the deployment that is **about** to be run. The user will then have the opportunity to confirm (with a 👍) or deny (with a 👎) the deployment.
1616

1717
Depending on the user's response (or lack of response), the branch-deploy Action will update the comment with the outcome.
1818

19+
The only reaction (👍 or 👎) that will be considered is the first reaction from the original actor that invoked the deployment (via `.deploy`). For example, if `@monalisa` comments `.deploy`, only `@monalisa` can give deployment confirmation via a reaction. All other reactions will be ignored on the deployment confirmation comment.
20+
1921
### Usage
2022

2123
```yaml

0 commit comments

Comments
 (0)