Skip to content

GitHub Action to add reviewer(s) to a pull request.

License

Notifications You must be signed in to change notification settings

lauren-themis/add-reviewer-gh-action

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

add-reviewer-gh-action

GitHub Action to add reviewer(s) to a pull request.

GitHub will add CODEOWNERS as reviewers at the start of a pull request, before any steps of the workflow have run or passed. This action allows reviewers to be specified so that they will be added when this step of the workflow runs, such as at the end of a workflow, instead of at the start to avoid early notifications while work is not ready.

Usage

- name: Add Pull Request Reviewer
      uses: rhs/add-reviewer-gh-action@1.0.6
      with: 
        reviewers: "AveryCameronUofR"
        token: ${{ secrets.GITHUB_TOKEN }}

Action Inputs

Name Description Default
token GITHUB_TOKEN or a repo scoped PAT. GITHUB_TOKEN
reviewers The email or user name of the reviewer(s) to add. If more than one use a comma separated list. none
remove Remove a review request (boolean) false

Action Outputs

None

Action Result

Fails workflow when invalid reviewer added, this may be the result of an incorrect name or email.

Modification

To use and modify the action for yourself: Make sure that node is installed on your computer. Then run npm install to update node_modules.

Make configuration modifications to the actions.yml file as needed.

Build new dist/index.js file with ncc: npx ncc build index.js

Create a new release tag and publish.

About

GitHub Action to add reviewer(s) to a pull request.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%