Skip to content
An action which adds reviewers to the pull request when the pull request is opened.
TypeScript JavaScript
Branch: master
Clone or download
kentaro-m Merge pull request #10 from evantianx/master
doc: update usage version v1 to v1.0.1
Latest commit f74b4b6 Nov 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
__tests__ Update logger messages Oct 5, 2019
dist
src Update logger messages Oct 5, 2019
.gitignore Add unit tests Oct 5, 2019
.prettierrc.yml Format codes using the Prettier Oct 5, 2019
LICENCE Add the implementation for auto-assign action Oct 2, 2019
README.md doc: update usage version v1 to v1.0.1 Nov 15, 2019
action.yml Change action name Oct 5, 2019
jest.config.js
package-lock.json Format codes using the Prettier Oct 5, 2019
package.json Release v1.0.1 Oct 5, 2019
tsconfig.json Add the implementation for auto-assign action Oct 2, 2019

README.md

Auto Assign Action

An action which adds reviewers to the pull request when the pull request is opened.

▶️ Usage

Create a workflow (e.g. .github/workflows/action.yml For more detail, refer to Configuring a workflow) for running the auto-assign action. Also, add the GITHUB_TOKEN, in order for the auto-assign action to calls the GitHub API.

name: 'Auto Assign'
on: pull_request

jobs:
  add-reviews:
    runs-on: ubuntu-latest
    steps:
      - uses: kentaro-m/auto-assign-action@v1.0.1
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"

Create a configuration file (e.g. .github/auto_assign.yml) for auto-assign action.

Single Reviewers List

Add reviewers/assignees to the pull request based on single reviewers list.

# Set to true to add reviewers to pull requests
addReviewers: true

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

# 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

Multiple Reviewers List

Add reviewers/assignees to the pull request based on multiple reviewers list.

If you and peers work at the separate office or they work at the separate team by roles like frontend and backend, you might be good to use adding reviewers from each group.

# Set to true to add reviewers to pull requests
addReviewers: true

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

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

# 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

# Set to true to add reviewers from different groups to pull requests
useReviewGroups: true

# A list of reviewers, split into different groups, to be added to pull requests (GitHub user name)
reviewGroups:
  groupA:
    - reviewerA
    - reviewerB
    - reviewerC
  groupB:
    - reviewerD
    - reviewerE
    - reviewerF

# Set to true to add assignees from different groups to pull requests
useAssigneeGroups: false

# A list of assignees, split into different froups, to be added to pull requests (GitHub user name)
# assigneeGroups:
#   groupA:
#     - assigneeA
#     - assigneeB
#     - assigneeC
#   groupB:
#     - assigneeD
#     - assigneeE
#     - assigneeF

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

Assign Author as Assignee

Add the PR creator as assignee to the pull request.

# Set to author to set pr creater as assignee
addAssignees: author

📝 Licence

MIT

You can’t perform that action at this time.