/pr-add-reviewers

A GitHub Action which will add users/teams as reviewers to an open pull request.

Primary LanguageJavaScriptMIT LicenseMIT

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