Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bullrich committed Oct 30, 2023
1 parent 3224f60 commit cddb9b2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ on:
permissions:
contents: read
checks: write
pull-requests: write
jobs:
review-approvals:
Expand All @@ -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.
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit cddb9b2

Please sign in to comment.