Skip to content

Commit c287204

Browse files
committed
docs: address CodeRabbit feedback - permissions, fork caveat, diff-filter
1 parent cbcc61b commit c287204

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

docs/cloud/features/ci.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ jobs:
6363
elementary-review:
6464
runs-on: ubuntu-latest
6565
permissions:
66+
contents: read
6667
pull-requests: write
6768
steps:
6869
- uses: actions/checkout@v4
@@ -86,12 +87,16 @@ Go to **Settings > Secrets and variables > Actions** and add:
8687

8788
That's it. Open a PR that touches a model file and the review comment appears automatically.
8889

90+
<Warning>
91+
This works for pull requests opened from branches within the same repository. GitHub does not pass repository secrets to `pull_request` workflows triggered by forks or Dependabot.
92+
</Warning>
93+
8994
<Accordion title="Optional: customize the action">
9095

9196
| Input | Default | Description |
9297
|---|---|---|
9398
| `models-path` | `models/` | Path to your dbt models directory |
94-
| `diff-filter` | `ACM` | File changes to include: A=Added, C=Copied, M=Modified |
99+
| `diff-filter` | `ACMR` | File changes to include: A=Added, C=Copied, M=Modified, R=Renamed |
95100
| `claude-model` | `claude-haiku-4-5-20251001` | Claude model to use. Switch to `claude-sonnet-4-6` for deeper analysis on complex changes |
96101
| `base-ref` | PR base branch | Branch to diff against |
97102

@@ -130,7 +135,7 @@ Open an MR that touches a model file and the review comment appears automaticall
130135

131136
**No comment appears after the job runs**
132137

133-
For GitHub, make sure `pull-requests: write` is set under `permissions` in the workflow file. GitHub Actions requires this explicitly to post PR comments.
138+
Make sure both `contents: read` and `pull-requests: write` are set under `permissions` in the workflow. An explicit `permissions` block sets any unlisted scope to `none` — omitting `contents: read` causes the checkout step to fail before Elementary runs.
134139

135140
**`git diff` returns no changed models**
136141

0 commit comments

Comments
 (0)