Auto Assign

Add reviewers/assignees to pull requests when pull requests are opened.
Screenshot of Auto Assign app
Screenshot of Auto Assign app

Repository

kentaro-m/auto-assign

Authors

kentaro-m

Updated

November 8, 2024

Used By

flutter ant-design HeroTransitions Requarks gofiber theme-next pypa status-im instructure aragon

What it does

Auto Assign adds reviewers/assignees to pull requests when pull requests are opened.

How it works

  • When the pull request is opened, automatically add reviewers/assignees to the pull request.
  • If the number of reviewers/assignees is specified, randomly add reviewers/assignees to the pull request.
  • If the title of the pull request contains a specific keyword, do not add reviewers/assignees to the pull request.

Usage

  1. Install the app.
  2. Create .github/auto_assign.yml in your repository.
# Set to true to add reviewers to pull requests
addReviewers: true

# Set to true to add assignees to pull requests
addAssignees: true

# A list of reviewers to be added to pull requests (GitHub user name)
reviewers:
  - reviewerA
  - reviewerB
  - reviewerC

# A number of reviewers added to the pull request
# Set 0 to add all the reviewers (default: 0)
numberOfReviewers: 0

# A list of assignees, overrides reviewers if set
# assignees:
#   - assigneeA

# A number of assignees to add to the pull request
# Set to 0 to add all of the assignees.
# Uses numberOfReviewers if unset.
# numberOfAssignees: 2

# A list of keywords to be skipped the process that add reviewers if pull requests include it
# skipKeywords:
#   - wip

Contributing

If you have suggestions for how auto-assign could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

Get occasional updates on new apps & features.

Star

with by the Probot community

Code licensed ISC Docs licensed CC-BY-4.0