Skip to content

Commit d5e094a

Browse files
committed
doc: explicit permissions to set for comments
1 parent 02f48b1 commit d5e094a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ For better security, we advise generating a specific `CLEVER_SECRET` and `CLEVER
3333

3434
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.
3535

36+
### Permissions
37+
38+
At job level, set the appropriate permissions to enable comments on PRs:
39+
40+
```yaml
41+
jobs:
42+
deploy:
43+
name: Deploy/redeploy review app
44+
runs-on: ubuntu-latest
45+
permissions:
46+
issues: write
47+
pull-requests: write
48+
contents: read
49+
```
50+
3651
## How to Use this Action
3752
3853
1. In your `.github/workflow/review-app.yml`, define the event trigger for running the action:
@@ -53,6 +68,7 @@ on:
5368
CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
5469
CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
5570
ORGA_ID: ${{ secrets.ORGA_ID }}
71+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5672
with:
5773
type: '<type-of-app>'
5874
```

0 commit comments

Comments
 (0)