Skip to content

Commit f1496df

Browse files
docs: add GitHub App install prerequisite and remove permissions block (#87)
oasdiff now posts PR comments and commit statuses via a GitHub App (not via the workflow's GITHUB_TOKEN), so the permissions block is no longer needed and users must install the App on their repo first. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 2025fa1 commit f1496df

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,12 @@ File paths and git refs require the repository to be checked out first:
129129

130130
`oasdiff/oasdiff-action/pr-comment@v0.0.37` posts a single auto-updating comment on every PR that touches your API spec.
131131

132+
**Prerequisite:** oasdiff posts comments and commit statuses as a GitHub App. [Install the oasdiff GitHub App](https://github.com/apps/oasdiff/installations/new) on each repository before using this action.
133+
132134
```yaml
133135
jobs:
134136
oasdiff:
135137
runs-on: ubuntu-latest
136-
permissions:
137-
pull-requests: write
138-
statuses: write
139138
steps:
140139
- uses: oasdiff/oasdiff-action/pr-comment@v0.0.37
141140
with:

0 commit comments

Comments
 (0)