Skip to content

Commit ffafdb8

Browse files
vaindclaude
andcommitted
docs: move permissions into usage examples
Include required permissions directly in the example workflow code for better visibility and easier copy-paste experience. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6a24e33 commit ffafdb8

File tree

2 files changed

+10
-22
lines changed

2 files changed

+10
-22
lines changed

danger/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ on:
1111
pull_request:
1212
types: [opened, synchronize, reopened, edited, ready_for_review, labeled, unlabeled]
1313

14+
permissions:
15+
contents: read # To read repository files
16+
pull-requests: write # To post comments on pull requests
17+
statuses: write # To post commit status checks
18+
1419
jobs:
1520
danger:
1621
runs-on: ubuntu-latest
@@ -25,17 +30,6 @@ jobs:
2530
* required: false
2631
* default: `${{ github.token }}`
2732

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-
3933
## Outputs
4034

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

updater/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ on:
1515
branches:
1616
- main
1717

18+
permissions:
19+
contents: write # To modify files and create commits
20+
pull-requests: write # To create and update pull requests
21+
actions: write # To cancel previous workflow runs
22+
1823
jobs:
1924
# Update a git submodule
2025
cocoa:
@@ -104,17 +109,6 @@ jobs:
104109
* type: string
105110
* required: true
106111

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-
118112
## Outputs
119113

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

0 commit comments

Comments
 (0)