https://github.com/remind101/action-require-reviewer
Github workflow action to require a reviewer on pushed branches
https://github.com/remind101/action-require-reviewer
Last synced: over 1 year ago
JSON representation
Github workflow action to require a reviewer on pushed branches
- Host: GitHub
- URL: https://github.com/remind101/action-require-reviewer
- Owner: remind101
- Created: 2021-01-14T19:09:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-08T20:28:30.000Z (over 5 years ago)
- Last Synced: 2025-01-10T16:37:41.645Z (over 1 year ago)
- Language: TypeScript
- Size: 11.9 MB
- Stars: 1
- Watchers: 26
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Require Reviewer
Check for a user/group to have reviewed a pull request
## Inputs
### `whoms`
**Required** Github user names or org groups. e.g. `username` or `@org/group`
### `GITHUB_TOKEN`
**Required** A token with the following permissions is required for organization related checks: `read:org` and `repo:status`
### `SKIP`
A common separated list of text to match in the pull body, which will skip this action if found.
### `SKIP_LABEL`
A single tag name that will skip verifiying this PR
## Outputs
### `missing`
Missing reviews from
## Example usage
Add an auth token with the correct permissions (see above) to your secrets as `AUTH_GITHUB_TOKEN`
```
on:
pull_request:
types: ['opened','synchronize','reopened','edited','labeled','unlabeled']
pull_request_review:
types: ['submitted','edited','dismissed']
jobs:
require_review:
runs-on: ubuntu-latest
name: Requires Review
steps:
- name: Check reviewers
uses: remind101/action-require-reviewer@v1
with:
whoms: "user,@team"
skip: "skip-review","skipreview"
skip_tag: "skip-review"
GITHUB_TOKEN: ${{ secrets.AUTH_GITHUB_TOKEN }}
```