Skip to content

Commit 6a24e33

Browse files
vaindclaude
andcommitted
docs: add required permissions to action README files
Document the specific GitHub permissions needed for each action based on testing experience to prevent API permission errors. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3a4d2e4 commit 6a24e33

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

danger/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ jobs:
2525
* required: false
2626
* default: `${{ github.token }}`
2727

28+
## Required Permissions
29+
30+
For workflows using this action, you need to set the following permissions:
31+
32+
```yaml
33+
permissions:
34+
contents: read # To read repository files
35+
pull-requests: write # To post comments on pull requests
36+
statuses: write # To post commit status checks
37+
```
38+
2839
## Outputs
2940

3041
* `outcome`: Whether the Danger run finished successfully. Possible values are `success`, `failure`, `cancelled`, or `skipped`.

updater/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,17 @@ jobs:
104104
* type: string
105105
* required: true
106106

107+
## Required Permissions
108+
109+
For workflows using this action, you need to set the following permissions:
110+
111+
```yaml
112+
permissions:
113+
contents: write # To modify files and create commits
114+
pull-requests: write # To create and update pull requests
115+
actions: write # To cancel previous workflow runs
116+
```
117+
107118
## Outputs
108119

109120
* `prUrl`: The created/updated PR's URL.

0 commit comments

Comments
 (0)