add-reviewers's Introduction

Add Reviewers

Github action that adds Reviewers to the Pull Request

Usage

Pre-requisites

Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

token - [required] Github personal token to add commits to Pull Request
reviewers - [required] Comma separated list of reviewers [eg. john,kramer,seinfeld]
re-request-when-changes-requested - [optional] If true, when a reviewer has requested for changes, pushing a new commit to this PR will Re-request a review from them
re-request-when-approved - [optional] If true, when a reviewer has approved, pushing a new commit to this PR will Re-request a review from them

Example Workflow

name: Add Reviewers

on:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Add Reviewers
      uses: madrapps/add-reviewers@v1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        reviewers: john,kramer,seinfeld
        re-request-when-approved: true
        re-request-when-changes-requested: true

Example Project

For a working project refer to jacoco-playgound project. Check out the PR's in the project to get an idea on how the report is shown on a pull request comment.

License

The scripts and documentation in this project are released under the MIT License

add-reviewers's People

Contributors

Stargazers

Watchers

add-reviewers's Issues

HttpError: Resource not accessible by integration

Hello, I just got a Error: HttpError: Resource not accessible by integration when using the action:

You can find the workflow implementation here: https://github.com/GuillaumeFalourd/useful-actions/blob/main/.github/workflows/add-reviewers.yml

The workflow run with the error can also be found here: https://github.com/GuillaumeFalourd/useful-actions/runs/3894145396?check_suite_focus=true

Any idea why it happened? And how to resolve it?

Support team reviewers

Hi @thsaravana
Currently this GH action only supports users reviewers. I'd like it to support also team reviewers.
The API supports it so it should be easy to add it.

I'd like to add it so either one of reviewers or team_reviewers is required. Does it sound right? would you be open for such PR of mine?

Review cannot be requested from pull request author

The action fails if the author of the PR is entered as a reviewer. This also does not add the other reviewers. An option to ignore this error and add the other reviewers would be great.

Unable to use your Action to add the reviewers

Hi ,

I'm trying to use your action in my workflow for the below scenario. Workflow was able to create a PR and merge to Staging branch when there are no conflicts, but when there are conflicts it is running the whole workflow but unable to add the reviewer. so can you please help me where exactly i'm going wrong.

Note: when i create a PR manually from Master to Staging your action is working fine in the separate workflow but when i add to my workflow it is not adding the reviewer.

Scenario - I have three branches Master, Staging and testbranch... when i do some changes in testbranch and merge the PR to Master... a workflow need to be triggered and a PR need to be raised from Master to Staging branch and it should be merged if there are no conflicts.. and if there are conflicts then a reviewer need to be added.

Recommend Projects