Settings for how review requests are sent, and how many approvals are required.
version: 3 groups: code: reviews: # 3 approvals from this group are required required: 3 # 1 review request will be sent at a time request: 1 # reviewers will be chosen in a random order request_order: shuffle # if the PR author is in this group, automatically add +1 author_value: 1
The number of people who need to approve a PR.
The default is
required: -1, then all users in the group will be required.
The number of people who should be requested for review at any given time.
For example, if
request: 1 (the default) then 1 review request will be sent at a time until the number of
required approvals are met.
request: -1 then review requests will be sent to as many people as are still
required to approve.
random) to have reviewers selected randomly from the group. This is the default setting.
given to request reviewers in the order specified by your config.
This works best when using
but it can also work with
reviewers.teams (the order inside each team is determined by the GitHub API).
version: 3 groups: code: reviews: required: 1 request: 1 request_order: given reviewers: users: - typicalreviewer - fallbackreviewer1 - fallbackreviewer2
If the author of the PR is in this group, then
author_value will be added to the review "score". By default
author_value: 1 to effectively have the PR be "approved" by the author -- this will mean 1 less person from the group will have to approve to meet the number
version: 3 groups: code: reviews: # only 2 approvals required if author is in this group required: 3 author_value: 1 code: reviews: # only 1 approval required if author is in this group required: 3 author_value: 2 code: reviews: # no approval required if author is in this group required: 3 author_value: 3
To require more reviews if the author is in the group, then use a negative number.
author_value: -2 would require an additional 2 approvals from this group.
This might be useful if you want to ensure that any PR that this group "owns" gets more reviews than they usually do.
For example, if the "security" team needs to give extra attention to their own PRs.
version: 3 groups: security: reviews: # 4 approvals will be required if the author is in the security group required: 3 author_value: -1
Note that on GitHub, authors can't actually review their own PR.