Skip to content

Commit 674f464

Browse files
authored
docs: document the required permissions for the GitHub token (#222)
1 parent 080bd75 commit 674f464

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525
lint-pr:
2626
name: Lint pull request title
2727
runs-on: ubuntu-latest
28+
permissions:
29+
pull-requests: write # post comments when 'comment' is true
2830
steps:
2931
- name: Lint pull request title
3032
uses: jef/conventional-commits-pr-action@v1
@@ -41,6 +43,8 @@ jobs:
4143
| Default value | `true` |
4244
|---------------|--------|
4345

46+
**Note**: commenting in the pull request conversation requires that the token is configured with the `pull-requests` permission.
47+
4448
### `token`
4549

4650
**Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.

0 commit comments

Comments
 (0)