actions/manual-approval
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Pause your GitHub Actions workflow and request manual approval from set approvers before continuing
20 commits 40 branches 1 tag 4.3 MiB
Find a file
Thomas Stringer 9dd24779eb Fix bug with not accepting newlines 
Prior to this PR, if there was a newline (or multiple newline
characters) at the end of the keyword then it wouldn't match. With this
fix any number of newlines at the end of the keyword match will now be
considered for approve or deny.
2022-05-25 19:38:04 -04:00
.github/workflows fix workflow 2022-03-25 21:31:42 -04:00
action.yaml Release version 1.3.0 (#10) 2022-05-24 19:58:17 -04:00
approval.go Fix bug with not accepting newlines 2022-05-25 19:38:04 -04:00
approval_test.go Fix bug with not accepting newlines 2022-05-25 19:38:04 -04:00
approvalstatus.go initial commit 2022-03-24 20:41:13 -04:00
constants.go Set minimum approvals (#1) 2022-04-05 09:05:47 -04:00
Dockerfile add label for dockerfile and basic readme text 2022-03-24 20:43:13 -04:00
go.mod initial commit 2022-03-24 20:41:13 -04:00
go.sum initial commit 2022-03-24 20:41:13 -04:00
LICENSE Initial commit 2022-03-24 20:43:53 -04:00
main.go Close issue if action cancelled (#4) 2022-04-28 08:20:50 -04:00
Makefile add workflow and readme 2022-03-25 21:28:51 -04:00
README.md Set minimum approvals (#1) 2022-04-05 09:05:47 -04:00

README.md

Manual Workflow Approval

ci

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, 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.
  2. manual-approval will create an issue in the containing repository and assign it to the approvers.
  3. If and once all approvers respond with an approved keyword, the workflow will continue.
  4. If any of the approvers responds with a denied keyword, then the workflow will exit with a failed status.
  • Approval keywords - "approve", "approved", "lgtm", "yes"
  • Denied keywords - "deny", "denied", "no"

These are case insensitive with optional punctuation either a period or an exclamation mark.

In all cases, manual-approval will close the initial GitHub issue.

Usage

steps:
  - uses: trstringer/manual-approval@v1
    with:
      secret: ${{ github.TOKEN }}
      approvers: user1,user2
      minimum-approvals: 1
  • approvers is a comma-delimited list of all required approvers.
  • minimum-approvals is an integer that sets the minimum number of approvals required to progress the workflow. Defaults to ALL approvers.