Skip to content

Commit 1ee0b0f

Browse files
committed
docs: add pull-requests write permission requirement for comment feature
1 parent c58f963 commit 1ee0b0f

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs/getting-started/github-action.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ jobs:
8282

8383
When enabled on a `pull_request` workflow, the action posts (or updates) a comment on the PR with a summary of test results — including pass/fail counts and failed scenario details.
8484

85+
> **Note:** The `comment` feature requires `pull-requests: write` permission. See the [complete workflow example](#complete-workflow-example) below.
86+
8587
### Pin to Specific Version
8688

8789
```yaml
@@ -101,6 +103,9 @@ on:
101103
pull_request:
102104
branches: [main]
103105
106+
permissions:
107+
pull-requests: write
108+
104109
jobs:
105110
test:
106111
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)