-
Notifications
You must be signed in to change notification settings - Fork 441
606 lines (527 loc) Β· 28.1 KB
/
Copy pathclaude-review.yml
File metadata and controls
606 lines (527 loc) Β· 28.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
# Integrates Claude Code as an AI assistant for reviewing pull requests.
# Mention @claude in any PR comment to request a review. Claude authenticates
# via AWS Bedrock using OIDC β no long-lived API keys required.
#
# Architecture: The workflow is split into three jobs for least-privilege:
# 1. "setup" β fetches PR context, posts/updates tracking comment (write permissions)
# 2. "review" β runs Claude with read-only permissions, produces structured JSON
# 3. "post" β reads the JSON and posts comments to the PR (write permissions)
name: Claude Review
on:
pull_request_target:
types: [opened, synchronize, reopened, labeled]
# Strangely enough you have to use issue_comment to react to regular comments on PRs.
# See https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_comment-use-issue_comment.
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
pull_request_review:
types: [submitted]
concurrency:
group: claude-review-${{ github.event.pull_request.number || github.event.issue.number }}
jobs:
setup:
runs-on: ubuntu-latest
env:
PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
if: |
github.repository_owner == 'systemd' &&
((github.event_name == 'pull_request_target' &&
(github.event.action == 'labeled' && github.event.label.name == 'claude-review' && github.event.sender.login != 'github-actions[bot]' ||
github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'claude-review') ||
github.event.action == 'opened' &&
contains(fromJSON('["MEMBER","OWNER","COLLABORATOR"]'), github.event.pull_request.author_association) &&
github.event.pull_request.user.login != 'YHNdnzj')) ||
(github.event_name == 'issue_comment' &&
github.event.issue.pull_request &&
contains(github.event.comment.body, '@claude review') &&
contains(fromJSON('["MEMBER","OWNER","COLLABORATOR"]'), github.event.comment.author_association)) ||
(github.event_name == 'pull_request_review_comment' &&
contains(github.event.comment.body, '@claude review') &&
contains(fromJSON('["MEMBER","OWNER","COLLABORATOR"]'), github.event.comment.author_association)) ||
(github.event_name == 'pull_request_review' &&
contains(github.event.review.body, '@claude review') &&
contains(fromJSON('["MEMBER","OWNER","COLLABORATOR"]'), github.event.review.author_association)))
permissions:
contents: read
pull-requests: write
outputs:
pr_number: ${{ steps.context.outputs.pr_number }}
comment_id: ${{ steps.context.outputs.comment_id }}
steps:
- name: Auto-add claude-review label for trusted contributors
if: github.event_name == 'pull_request_target' && github.event.action == 'opened'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh pr edit --repo "${{ github.repository }}" "$PR_NUMBER" --add-label claude-review
- name: Fetch PR context and create tracking comment
id: context
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd
with:
script: |
const owner = context.repo.owner;
const repo = context.repo.repo;
const prNumber = parseInt(process.env.PR_NUMBER, 10);
const runUrl = `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`;
const MARKER = "<!-- claude-pr-review -->";
/* Fetch all PR data in parallel. */
const [pr, reviews, issueComments, reviewComments] = await Promise.all([
github.rest.pulls.get({ owner, repo, pull_number: prNumber }),
github.paginate(github.rest.pulls.listReviews, { owner, repo, pull_number: prNumber, per_page: 100 }),
github.paginate(github.rest.issues.listComments, { owner, repo, issue_number: prNumber, per_page: 100 }),
github.paginate(github.rest.pulls.listReviewComments, { owner, repo, pull_number: prNumber, per_page: 100 }),
]);
/* Find or create tracking comment. */
const existing = issueComments.find((c) => c.body && c.body.includes(MARKER));
let commentId;
let trackingCommentBody = null;
if (existing) {
console.log(`Updating existing tracking comment ${existing.id}.`);
/* Prepend a re-reviewing banner but keep the previous review visible. */
const prevBody = existing.body.replace(/\n\n\[Workflow run\]\([^)]*\)$/, "");
await github.rest.issues.updateComment({
owner,
repo,
comment_id: existing.id,
body: `> **Claude is re-reviewing this PRβ¦** ([workflow run](${runUrl}))\n\n${prevBody}`,
});
commentId = existing.id;
trackingCommentBody = prevBody;
} else {
console.log("Creating new tracking comment.");
const {data: created} = await github.rest.issues.createComment({
owner,
repo,
issue_number: prNumber,
body: `Claude is reviewing this PR⦠([workflow run](${runUrl}))\n\n${MARKER}`,
});
commentId = created.id;
}
/* Build context JSON for Claude. */
const prContext = {
pr: pr.data,
reviews,
issue_comments: issueComments,
tracking_comment: trackingCommentBody,
review_comments: reviewComments,
};
core.setOutput("pr_number", prNumber);
core.setOutput("comment_id", commentId);
const fs = require("fs");
fs.writeFileSync("pr-context.json", JSON.stringify(prContext));
# archive: false makes upload-artifact use the file's basename
# (pr-context.json) as the artifact name, ignoring the name input.
- name: Upload PR context
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
with:
path: pr-context.json
archive: false
retention-days: 7
review:
runs-on: ubuntu-latest
needs: setup
permissions:
contents: read
id-token: write # Authenticate with AWS via OIDC
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
# Need full history so git diff <sha>~1..<sha> works for all PR commits.
fetch-depth: 0
- name: Fetch PR branch
env:
PR_NUMBER: ${{ needs.setup.outputs.pr_number }}
run: git fetch origin "pull/${PR_NUMBER}/head:pr-review"
- name: Download PR context
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
with:
name: pr-context.json
- name: Prettify PR context
run: python3 -m json.tool pr-context.json > pr-context-pretty.json && mv pr-context-pretty.json pr-context.json
- name: Install sandbox dependencies
run: |
sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
sudo apt-get update && sudo apt-get install -y bubblewrap socat
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@8df5847569e6427dd6c4fb1cf565c83acfa8afa7
with:
role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ROLE_NAME }}
role-session-name: GitHubActions-Claude-${{ github.run_id }}
aws-region: us-east-1
- name: Run Claude Code
id: claude
uses: anthropics/claude-code-action@26ec041249acb0a944c0a47b6c0c13f05dbc5b44
with:
use_bedrock: "true"
# Required by claude-code-action even though Claude itself doesn't
# call the GitHub API β the action uses it for permission checks.
github_token: ${{ secrets.GITHUB_TOKEN }}
# Safe because the workflow's `if` condition already restricts
# execution to trusted actors (MEMBER/OWNER/COLLABORATOR) or PRs
# that a trusted actor explicitly labeled, and this job only has
# read-only permissions.
allowed_non_write_users: "*"
track_progress: false
show_full_output: "true"
# Sandbox Bash commands to prevent network access and restrict
# filesystem writes to the working directory.
settings: |
{
"permissions": {
"allow": ["*"]
},
"sandbox": {
"enabled": true,
"autoAllowBashIfSandboxed": true,
"allowUnsandboxedCommands": false,
"filesystem": {
"allowWrite": ["//tmp", "//var/tmp"]
}
}
}
claude_args: |
--model us.anthropic.claude-opus-4-6-v1
--effort max
--max-turns 200
--disallowedTools "WebFetch,WebSearch"
--setting-sources user
prompt: |
REPO: ${{ github.repository }}
PR NUMBER: ${{ needs.setup.outputs.pr_number }}
You are a code reviewer for the ${{ github.repository }} project. Review this pull request and
produce a JSON result containing your review and write it to
`review-result.json` in the repo root. Do NOT attempt to post
comments yourself. You are in the upstream repo with the PR branch
available as `pr-review`. Do not apply or merge the patch.
You have no network access β all required context has been
pre-fetched locally.
## Phase 1: Read context
All PR data has been pre-fetched. Read `pr-context.json` from the repo root.
It contains a JSON object with:
- `pr` β full GitHub PR object (title, body, user, head SHA, etc.)
- `reviews` β array of PR reviews from the GitHub API
- `issue_comments` β array of issue comments on the PR from the GitHub API
- `tracking_comment` β body of the existing tracking comment (null on first run);
if present, use it as the basis for your `summary` in Phase 3
- `review_comments` β array of ALL inline review comments on the PR from the
GitHub API. Use these as context, but observe the following rules:
- Only re-check your own comments (user.login == "github-actions[bot]" and
body starts with "Claude: "). Do NOT validate, re-raise, respond to, or
duplicate comments from other authors.
- Items checked off in the tracking comment (`- [x]`) are resolved. Do NOT
re-check or re-raise review comments that correspond to resolved items.
- You will need the `id` fields of your own unresolved comments in Phase 3
to populate the `resolve` array.
The PR branch has been fetched locally as `pr-review`. Use
`git log --reverse --format=%H HEAD..pr-review` to list the PR commits, and
`git show <sha>` or `git diff <sha>~1..<sha>` to access commit diffs.
## Phase 2: Review commits
Review every commit in the PR. Use subagents to parallelize the
work β decide how many subagents to spawn and how to divide commits
between them and the main conversation based on the number and size
of commits. Very large commits can be assigned to multiple subagents
for extra thoroughness. Always review some commits yourself so you
have useful work to do while subagents run in the background. For
single-commit PRs with small diffs, just review directly without
subagents. For large single-commit PRs, have multiple subagents
review it independently to maximize coverage.
IMPORTANT: Always spawn subagents with `isolation: "worktree"` so
each gets its own git worktree. This prevents concurrent git
operations from interfering with each other. Because worktrees
do not include untracked files, first `git add pr-context.json`
so it is available in worktrees.
Each reviewer (you or a subagent) uses `git show <sha>` or
`git diff <sha>~1..<sha>` to fetch diffs, reads `pr-context.json`
for PR context, and reads the codebase to verify findings.
Each reviewer reviews code quality, style, potential bugs, and security
implications. It must return a JSON array of issues:
`[{"file": "path", "line": <number> (optional), "severity": "must-fix|suggestion|nit", "body": "...", "commit": "<sha>"}]`
The `commit` field MUST be the SHA of the commit being reviewed. Only
comment on changes in that commit β not preceding commits.
Do NOT escape characters in `body`. Write plain markdown β no backslash
escaping of `!` or other characters.
`line` should be a line number from the NEW side of the diff **that appears
inside a diff hunk**. GitHub rejects lines outside the diff context. If you
cannot determine a valid diff line, omit `line`.
Each reviewer MUST verify findings before returning them:
- For style/convention claims, check at least 3 existing examples in the
codebase to confirm the pattern actually exists before flagging a violation.
- For "use X instead of Y" suggestions, confirm X actually exists and works.
- If unsure, don't include the issue.
## Phase 3: Collect, deduplicate, and summarize
After all reviews (yours and any subagents') are done:
1. Collect all issues. Merge duplicates (same file, lines within 3 of each other, same problem).
2. Drop low-confidence findings.
3. Check the existing inline review comments fetched in Phase 1. Do NOT include a
comment if one already exists on the same file and line about the same problem.
Also check for author replies that dismiss or reject a previous comment β do NOT
re-raise an issue the PR author has already responded to disagreeing with.
Populate the `resolve` array with the REST API `id` (integer) of existing
review comments whose threads should be resolved. A thread should be resolved if:
- The issue it raised has been addressed in the current PR (i.e. your review
no longer flags it), OR
- The PR author (or another reviewer) left a reply disagreeing with or
dismissing the comment.
Only include the `id` of the **first** comment in each thread (the one that
started the conversation). Do NOT resolve threads for issues that are still
present and unaddressed.
4. Do NOT prefix `body` with a severity tag β the severity is already
captured in the `severity` field and will be added automatically when
posting inline comments.
5. Write a `summary` field in markdown for a top-level tracking comment.
**If no existing tracking comment was found (first run):**
Use this format:
```
## Claude review of PR #<number> (<HEAD SHA>)
<!-- claude-pr-review -->
### Must fix
- [ ] **short title** β `file:line` β brief explanation
### Suggestions
- [ ] **short title** β `file:line` β brief explanation
### Nits
- [ ] **short title** β `file:line` β brief explanation
```
Omit empty sections. Each checkbox item must correspond to an entry in `comments`.
If there are no issues at all, write a short message saying the PR looks good.
**If an existing tracking comment was found (subsequent run):**
Use the existing comment as the starting point. Preserve the order and wording
of all existing items. Then apply these updates:
- Update the HEAD SHA in the header line.
- For each existing item, re-check whether the issue is still present in the
current diff. If it has been fixed, mark it checked: `- [x]`.
- If the PR author replied dismissing an item, mark it:
`- [x] ~~short title~~ (dismissed)`.
- Preserve checkbox state that was already set by previous runs or by hand.
- Append any NEW issues found in this run that aren't already listed,
in the appropriate severity section, after the existing items.
- Do NOT reorder, reword, or remove existing items.
## Error tracking
If any errors prevented you from doing your job fully (tools that were
not available, git commands that failed, etc.), append a `### Errors`
section to the summary listing each failed action and the error message.
## CRITICAL: Write review result to file
Your FINAL action must be to write `review-result.json` in the repo
root. The file must contain a JSON object with the following schema:
```json
{
"summary": "...",
"comments": [
{
"file": "path/to/file",
"line": 42,
"severity": "must-fix|suggestion|nit",
"body": "review comment in markdown",
"commit": "abc123"
}
],
"resolve": [12345]
}
```
- `summary` (required): markdown summary for the tracking comment
- `comments` (required): array of review comments; `line` is optional
- `resolve` (optional): REST API IDs of review comment threads to resolve
Do NOT attempt to post comments or use any MCP tools to modify the PR.
- name: Upload review result
if: always()
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
with:
path: review-result.json
if-no-files-found: ignore
archive: false
retention-days: 7
post:
runs-on: ubuntu-latest
needs: [setup, review]
if: always() && needs.setup.result == 'success'
permissions:
pull-requests: write
steps:
- name: Download review result
if: needs.review.result == 'success'
continue-on-error: true
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
with:
name: review-result.json
- name: Post review comments
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd
env:
REVIEW_RESULT: ${{ needs.review.result }}
PR_NUMBER: ${{ needs.setup.outputs.pr_number }}
COMMENT_ID: ${{ needs.setup.outputs.comment_id }}
with:
script: |
const fs = require("fs");
const owner = context.repo.owner;
const repo = context.repo.repo;
const prNumber = parseInt(process.env.PR_NUMBER, 10);
const commentId = parseInt(process.env.COMMENT_ID, 10);
const runUrl = `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`;
const MARKER = "<!-- claude-pr-review -->";
/* If the review job failed or was cancelled, update the tracking
* comment to reflect that and bail out. */
if (process.env.REVIEW_RESULT !== "success") {
const verb = process.env.REVIEW_RESULT === "cancelled" ? "was cancelled" : "failed";
await github.rest.issues.updateComment({
owner,
repo,
comment_id: commentId,
body: `Claude review ${verb} β see [workflow run](${runUrl}) for details.\n\n${MARKER}`,
});
core.setFailed("Review job did not succeed.");
return;
}
/* Parse Claude's review result from the downloaded artifact. */
let raw = "";
try {
raw = fs.readFileSync("review-result.json", "utf8");
} catch (e) {
console.log(`Failed to read review-result.json: ${e.message}`);
}
console.log("Review result from Claude:");
console.log(raw || "(empty)");
let comments = [];
let resolveIds = [];
let summary = "";
if (raw) {
try {
const review = JSON.parse(raw);
if (Array.isArray(review.comments))
comments = review.comments;
if (Array.isArray(review.resolve))
resolveIds = review.resolve;
if (typeof review.summary === "string")
summary = review.summary;
} catch (e) {
core.warning(`Failed to parse structured output: ${e.message}`);
}
}
console.log(`Claude produced ${comments.length} review comment(s).`);
/* Post each inline comment individually. Deduplication against existing
* comments is handled by Claude in the prompt, so we just post whatever
* it returns. Using individual comments (rather than a review) means
* re-runs only add new comments instead of creating a whole new review. */
const inlineComments = comments.filter((c) => c.line);
const skipped = comments.length - inlineComments.length;
if (skipped > 0)
console.log(`Skipping ${skipped} file-level comment(s) (no line number).`);
let posted = 0;
for (const c of inlineComments) {
console.log(` Posting comment on ${c.file}:${c.line}`);
try {
await github.rest.pulls.createReviewComment({
owner,
repo,
pull_number: prNumber,
commit_id: c.commit,
path: c.file,
line: c.line,
body: `Claude: **${c.severity}**: ${c.body}`,
});
posted++;
} catch (e) {
/* GitHub rejects comments on lines outside the diff context. Log
* and continue β the tracking comment still contains all findings. */
console.log(` Warning: failed to post comment on ${c.file}:${c.line}: ${e.message}`);
}
}
if (posted > 0)
console.log(`Posted ${posted}/${inlineComments.length} inline comment(s).`);
else if (inlineComments.length > 0)
console.log(`Could not post any of ${inlineComments.length} inline comment(s) β see warnings above.`);
else
console.log("No inline comments to post.");
/* Resolve review threads that Claude identified as addressed or dismissed. */
if (resolveIds.length > 0) {
const resolveSet = new Set(resolveIds);
/* Fetch all review threads and map first-comment database IDs to thread IDs. */
let threads = [];
try {
let threadCursor = null;
do {
const threadQuery = `
query($owner: String!, $repo: String!, $number: Int!, $cursor: String) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $number) {
reviewThreads(first: 100, after: $cursor) {
pageInfo { hasNextPage endCursor }
nodes {
id
isResolved
comments(first: 1) {
nodes {
databaseId
}
}
}
}
}
}
}
`;
const threadResult = await github.graphql(threadQuery, { owner, repo, number: prNumber, cursor: threadCursor });
const page = threadResult.repository.pullRequest.reviewThreads;
threads.push(...page.nodes);
threadCursor = page.pageInfo.hasNextPage ? page.pageInfo.endCursor : null;
} while (threadCursor);
} catch (e) {
console.log(`Warning: failed to fetch review threads, skipping resolution: ${e.message}`);
threads = [];
}
let resolved = 0;
let alreadyResolved = 0;
const matchedIds = new Set();
for (const thread of threads) {
const firstCommentId = thread.comments.nodes[0]?.databaseId;
if (!firstCommentId || !resolveSet.has(firstCommentId)) continue;
matchedIds.add(firstCommentId);
if (thread.isResolved) {
alreadyResolved++;
continue;
}
try {
await github.graphql(`
mutation($threadId: ID!) {
resolveReviewThread(input: { threadId: $threadId }) {
thread { id }
}
}
`, { threadId: thread.id });
resolved++;
console.log(` Resolved thread for comment ${firstCommentId}`);
} catch (e) {
console.log(` Warning: failed to resolve thread for comment ${firstCommentId}: ${e.message}`);
}
}
const requested = resolveSet.size;
const unmatched = [...resolveSet].filter(id => !matchedIds.has(id));
if (resolved > 0)
console.log(`Resolved ${resolved}/${requested} review thread(s)${alreadyResolved > 0 ? ` (${alreadyResolved} already resolved)` : ""}.`);
else if (alreadyResolved === requested)
console.log(`All ${requested} review thread(s) were already resolved.`);
else if (alreadyResolved > 0)
console.log(`${alreadyResolved}/${requested} review thread(s) were already resolved; could not resolve the rest β see warnings above.`);
else if (threads.length > 0)
console.log(`Could not resolve any of ${requested} review thread(s) β see warnings above.`);
if (unmatched.length > 0)
console.log(` ${unmatched.length} comment ID(s) not found in any thread: ${unmatched.join(", ")}`);
} else {
console.log("No review threads to resolve.");
}
/* Update the tracking comment with Claude's summary. */
if (!summary)
summary = "Claude review: no issues found :tada:\n\n" + MARKER;
else if (!summary.includes(MARKER))
summary += "\n\n" + MARKER;
summary += `\n\n[Workflow run](${runUrl})`;
await github.rest.issues.updateComment({
owner,
repo,
comment_id: commentId,
body: summary,
});
console.log("Tracking comment updated successfully.");
if (inlineComments.length > 0 && posted === 0)
core.setFailed(`Could not post any of ${inlineComments.length} inline comment(s) β see warnings above.`);
else if (posted < inlineComments.length)
core.warning(`${inlineComments.length - posted}/${inlineComments.length} inline comment(s) could not be posted.`);