Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
peternied authored Nov 28, 2023
1 parent 41019db commit 4faafd1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# approved-by-maintainers
Github action to verify that maintainers have approved this PR
# required-approval
Github action to verify the kinds of approvals on this PR. Useful to work around CODEOWNERS and min approvers settings that are typically only visible to project admins.

```yaml
inputs:
token:
description: "GitHub token used for authentication"
required: true
maintainers:
description: 'The list of maintainers that can approve the request, comma seperated'
specific-approvers:
description: 'The list of specific users that can approve the request, comma seperated.'
required: false
min-required:
description: 'The minimum number of maintainers required to approve, e.g. 2'
description: 'The minimum number of approvals, e.g. 2'
required: true
```
Expand All @@ -24,16 +24,17 @@ on:
types: [opened, reopened]
...
steps:
- id: find-maintainers
- id: list-maintainers
run: echo "maintainers='danny, ricky, bobby'" >> $GITHUB_ENV

- uses: peternied/approved-by-maintainers@v1
- uses: peternied/required-approval@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
min-required: 1
specific-approvers: ${{ steps.list-maintainers.outputs.maintainers }}
```
# Changelog
## v1
- Initial Release
- Initial Release

0 comments on commit 4faafd1

Please sign in to comment.