Skip to content

Commit

Permalink
doc: explicit permissions to set for comments
Browse files Browse the repository at this point in the history
  • Loading branch information
juliamrch committed Jul 30, 2024
1 parent 02f48b1 commit d5e094a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ For better security, we advise generating a specific `CLEVER_SECRET` and `CLEVER

Run `clever login` again and connect from your main account to set your personal tokens. Your GitHub Acction user's tokens won't be revoked and will be used only from GitHub.

### Permissions

At job level, set the appropriate permissions to enable comments on PRs:

```yaml
jobs:
deploy:
name: Deploy/redeploy review app
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
contents: read
```
## How to Use this Action
1. In your `.github/workflow/review-app.yml`, define the event trigger for running the action:
Expand All @@ -53,6 +68,7 @@ on:
CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
ORGA_ID: ${{ secrets.ORGA_ID }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
type: '<type-of-app>'
```
Expand Down

0 comments on commit d5e094a

Please sign in to comment.