diff --git a/README.md b/README.md index fb1a2b0..316ffd4 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ on: permissions: contents: read checks: write + pull-requests: write jobs: review-approvals: @@ -103,6 +104,7 @@ jobs: repo-token: ${{ github.token }} team-token: ${{ secrets.TEAM_TOKEN }} checks-token: ${{ secrets.CHECKS_TOKEN }} + request-reviewers: false pr-number: ${{ steps.number.outputs.content }} ``` Create a new PR and see if it is working. @@ -149,6 +151,10 @@ You can find all the inputs in [the action file](./action.yml), but let's walk t - You can use the same GitHub app for `checks-token` and `team-token`. - `config-file`: The location of the config file. - **default**: `.github/review-bot.yml` +- `request-reviewers`: If the system should automatically request the required reviewers. + - **default**: false. + - If enabled, when there are missing reviews, the system will request the appropriate users and/or team to review. + - If enabled, and using teams, this requires a GitHub action with `write` permission for `pull request`. #### Using a GitHub app instead of a PAT In some cases, specially in big organizations, it is more organized to use a GitHub app to authenticate, as it allows us to give it permissions per repository, and we can fine-grain them even better. If you wish to do that, you need to create a GitHub app with the following permissions: