docs: document the required permissions for the GitHub token (#222)

jef · Dec 11, 2024 · 674f464 · 674f464
1 parent 080bd75
commit 674f464
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ jobs:
   lint-pr:
     name: Lint pull request title
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # post comments when 'comment' is true
     steps:
       - name: Lint pull request title
         uses: jef/conventional-commits-pr-action@v1
@@ -41,6 +43,8 @@ jobs:
 | Default value | `true` |
 |---------------|--------|
 
+**Note**: commenting in the pull request conversation requires that the token is configured with the `pull-requests` permission.
+
 ### `token`
 
 **Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.