Skip to content

Commit

Permalink
Merge pull request #14 from GrantBirki/requested_reviewers
Browse files Browse the repository at this point in the history
update docs around `requested_reviewers` feature
  • Loading branch information
GrantBirki authored Jan 30, 2025
2 parents a9bc5db + 5d5be90 commit 2f46afd
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,15 @@ rules: # array of rules
- <string>
exclude_regex: # array of regex patterns for files to exclude from the rule (optional)
- <string>
requested_reviewers: # array of requested reviewers for the rule (optional)
- "octocat" # a single reviewer
- "org/team" # a team
# global configuration options
global_options:
alert_level: <fail|warn> # whether to fail or warn on violations - default is 'fail'
comment_on_pr: <boolean> # whether to comment on the PR with violation results - default is true
request_reviewers: false # whether to request reviewers on the PR if a violation is found - default is true
exclude_auditor_config: <boolean> # exclude the auditor config file from the audit (this file) - default is true
labels: # array of labels to apply to the PR if a violation is found - comment out to disable (optional)
- <string>
Expand Down

0 comments on commit 2f46afd

Please sign in to comment.