28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# Manual Workflow Approval
|
|
|
|
Pause a GitHub Actions workflow and require manual approval from one or more approvers before continuing.
|
|
|
|
This is a very common feature for a deployment or release pipeline, and while [this functionality is available from GitHub](https://docs.github.com/en/actions/managing-workflow-runs/reviewing-deployments), it requires the use of environments and if you want to use this for private repositories then you need GitHub Enterprise. This action provides manual approval without the use of environments, and is freely available to use on private repositories.
|
|
|
|
*Note: This approval duration is subject to the broader 72 hours timeout for a workflow. So keep that in mind when figuring out how quickly an approver must respond.*
|
|
|
|
The way this action works is the following:
|
|
|
|
1. Workflow comes to the `manual-approval` action.
|
|
1. `manual-approval` will create an issue in the containing repository and assign it to the `approvers`.
|
|
1. If and once all approvers respond with "Approved", the workflow will continue.
|
|
1. If any of the approvers responds with "Denied", then the workflow will exit with a failed status.
|
|
|
|
In all cases, `manual-approval` will close the initial GitHub issue.
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: trstringer/manual-approval@v1
|
|
with:
|
|
secret: ${{ github.TOKEN }}
|
|
approvers: user1,user2
|
|
```
|
|
|
|
`approvers` is a comma-delimited list of all required approvers.
|