GitHub Action
Required Review
This Github Action will check that required reviewers have accepted the PR, setting a status check accordingly.
name: Required review check
on:
pull_request_review:
pull_request:
types: [ opened, reopened, synchronize ]
jobs:
check:
name: Checking required reviews
runs-on: ubuntu-latest
# GitHub should provide a "pull_request_review_target", but they don't and
# the action will fail if run on a forked PR.
if: github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name
steps:
- uses: Automattic/action-required-review@v2
with:
requirements: |
- paths: unmatched
teams:
- maintenanceThis action is intended to be triggered by the pull_request_review event.
- uses: Automattic/action-required-review
with:
# Specify the requirements as a YAML string. See below for the format of this string.
# The easiest way to generate this is probably to write your YAML, then put the `|`
# after the key to make it a string.
requirements: |
- name: Docs
paths:
- 'docs/'
teams:
- documentation
- name: Everything else
paths: unmatched
teams:
- maintenance
# Specify the path to the requirements file. See below for the format of
# this file.
requirements-file: .github/required-review.yaml
# Specify the "context" for the status to set. This is what shows up in the
# PR's checks list.
status: Required review
# Personal access token used to fetch the list of changed files from Github
# REST API, and to submit the status check.
token: ${{ github.token }}The requirements consist of an array of requirement objects. A requirement object has the following keys:
-
nameis an optional informative name for the requirement. -
pathsis an array of path patterns, or the string "unmatched". If an array, the reviewers specified will be checked if any path in the array matches any path in the PR. If the string "unmatched", the reviewers are checked if any file in the PR has not been matched yet. -
teamsis an array of strings that are GitHub team slugs in the organization or repository. A review is required from a member of any of these teams.Instead of a string, a single-keyed object may be specified. The key is either
all-oforany-of, and the value is an array as forteams. When the key isall-of, a review is required from every team (but if a person is a member of multiple teams, they can satisfy multiple requirements). When it'sany-of, one review from any team is needed.Additionally, you can specify a single user by prefixing their username with
@. For example,@examplewill be treated as a virtual team with one member;example.
Paths are matched using the picomatch library.
Every requirement object that applies must have appropriate reviews, it's not "first match". Thus,
using the example below, a PR touching file at docs/foo.css would need reviews satisfying both
the "Docs" and "Front end" review requirements. If you wanted to avoid that, you might add
!**.css to the first's paths or !docs/** to the second's.
# Documentation must be reviewed by the documentation team.
- name: Docs
paths:
- 'docs/**'
teams:
- documentation
# Any CSS and React .jsx files must be reviewed by a front-end developer AND by a designer,
# OR by a member of the maintenance team.
- name: Front end
paths:
- '**.jsx'
- '**.css'
teams:
- all-of:
- front-end
- design
- maintenance
# All other files must be reviewed by the maintenance team.
- name: Misc
paths: unmatched
teams:
- maintenance