Skip to content
git-pull-request

GitHub Action

Add Reviewers to Pull Request

v1 Pre-release

Add Reviewers to Pull Request

git-pull-request

Add Reviewers to Pull Request

Add a reviewer to a pull request using API

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Add Reviewers to Pull Request

uses: ryaugusta/pr-add-reviewers@v1

Learn more about this action in ryaugusta/pr-add-reviewers

Choose a version

Add Reviewers to Pull Request

Build

This action will add reviewers to a pull request. It will not add reviewers that are not collaborators on the repository.

Inputs

Name Description Required
reviewers List of user logins, comma separated, that will be requested. Must be collaborators. no
team_reviewers List of team names, comma separated, that will be requested. Must be collaborators. no
token ${{ secrets.GITHUB_TOKEN }} yes

Example Usage:

You must provide either reviewers, team_reviewers or both for this action to run.

Add reviewer(s) to a pull request on the working repository

...
- uses: ryaugusta/pr-add-reviewers-action@v1
  with:
    token: ${{ github.token }}
    reviewers: '<user_name>'
    # team_reviewers: '<team_name>'
...

Note

In some cases you may see an error where there are invalid permissions if using the GITHUB_TOKEN secret. You can add specific permissions in your workflow for this:

runs-on: ubuntu-latest
permissions: write-all 
steps:
...

License

MIT