-
Notifications
You must be signed in to change notification settings - Fork 91
259 lines (238 loc) · 11.4 KB
/
Copy pathcodex-review.yml
File metadata and controls
259 lines (238 loc) · 11.4 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
name: Codex PR Review
on:
pull_request:
types: [opened, synchronize, reopened]
issue_comment:
types: [created]
concurrency:
group: codex-review-${{ github.event.pull_request.number || github.event.issue.number }}
cancel-in-progress: true
jobs:
authorize:
# Trigger gate: PR events always, comment events only for "@codex review" from a
# trusted commenter. The step then restricts to same-repo (non-fork) PRs so a
# public fork can never reach the privileged checkout below.
if: >
github.event_name == 'pull_request' ||
(github.event.issue.pull_request != null &&
contains(github.event.comment.body, '@codex review') &&
contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association))
runs-on: ubuntu-latest
permissions:
pull-requests: read
outputs:
ok: ${{ steps.gate.outputs.ok }}
pr: ${{ steps.gate.outputs.pr }}
steps:
- id: gate
uses: actions/github-script@v7
with:
github-token: ${{ github.token }}
script: |
const prNum = context.payload.pull_request?.number ?? context.payload.issue?.number;
if (!prNum) { core.setOutput('ok', 'false'); return; }
const { data: pr } = await github.rest.pulls.get({
owner: context.repo.owner, repo: context.repo.repo, pull_number: prNum,
});
const sameRepo = !!pr.head.repo && pr.head.repo.full_name === pr.base.repo.full_name;
core.setOutput('pr', String(prNum));
core.setOutput('ok', sameRepo ? 'true' : 'false');
if (!sameRepo) {
core.notice(`Skipping Codex review: PR #${prNum} is from a fork; only same-repo branches are reviewed.`);
}
review:
needs: authorize
if: needs.authorize.outputs.ok == 'true'
runs-on: ubuntu-latest
permissions:
contents: read
outputs:
result: ${{ steps.run_codex.outputs.final-message }}
steps:
- uses: actions/checkout@v4
with:
ref: refs/pull/${{ needs.authorize.outputs.pr }}/merge
fetch-depth: 0
persist-credentials: false
- name: Run Codex
id: run_codex
uses: openai/codex-action@v1
with:
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
model: gpt-5.5
effort: xhigh
sandbox: read-only
output-schema: |
{
"type": "object",
"additionalProperties": false,
"properties": {
"summary": { "type": "string" },
"findings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"path": { "type": "string" },
"line": { "type": "integer" },
"severity": { "type": "string", "enum": ["blocking", "consider"] },
"comment": { "type": "string" }
},
"required": ["path", "line", "severity", "comment"]
}
}
},
"required": ["summary", "findings"]
}
prompt: |
You are reviewing pull request #${{ needs.authorize.outputs.pr }} in ${{ github.repository }}.
The PR's changes are exactly the diff between the merge commit's two parents.
Run `git diff HEAD^1 HEAD^2` to see everything that changed, and
`git diff HEAD^1 HEAD^2 -- <path>` to focus on a single file.
Review ONLY those changes. Report high-signal findings only.
Correctness & safety:
- logic errors, unhandled edge cases, broken assumptions
- security vulnerabilities
- data loss, concurrency hazards, resource leaks
Design & code quality:
- the soundness of the overall approach, not just line-level bugs
- elegance: is there a simpler, cleaner way to achieve the same result?
- abstraction: prefer the most general clean abstraction that fits the problem,
without over-engineering for cases that don't exist
- redundancy: flag duplicated logic, dead code, and anything that violates DRY
Skip pure formatting and style nits.
Report at most the 5 most important findings. Consolidate an issue that
recurs in several places into one finding at the most representative location.
Output JSON matching the provided schema:
- `summary`: one or two sentences on the PR overall. If there are no real
issues, set summary to "No issues found." and findings to [].
- `findings[].path`: repository-relative file path, exactly as git reports it.
- `findings[].line`: the line number in the NEW (post-change) version of the
file. It MUST be a line the PR adds or modifies.
- `findings[].severity`: "blocking" or "consider".
- `findings[].comment`: markdown review comment with a short code snippet and a
concrete fix.
post_review:
needs: [authorize, review]
if: needs.review.outputs.result != ''
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Post inline review
uses: actions/github-script@v7
env:
CODEX_RESULT: ${{ needs.review.outputs.result }}
PR_NUMBER: ${{ needs.authorize.outputs.pr }}
with:
github-token: ${{ github.token }}
script: |
const { owner, repo } = context.repo;
const pull_number = Number(process.env.PR_NUMBER);
const SUMMARY_MARKER = '<!-- codex-review-summary -->';
const INLINE_MARKER = '<!-- codex-review-inline -->';
const MAX_COMMENTS = 5;
// Parse Codex JSON. With --output-schema the result is already pure JSON,
// and its findings may contain fenced code blocks, so never grab an inner
// fence: parse the whole string first, then a fence wrapping the whole
// string, then fall back to the outermost braces.
function parseResult(raw) {
if (!raw) return null;
const tryParse = (s) => { try { return JSON.parse(s); } catch { return null; } };
const trimmed = raw.trim();
let out = tryParse(trimmed);
if (out) return out;
const fence = trimmed.match(/^```(?:json)?\s*\n?([\s\S]*?)\n?```$/);
if (fence) { out = tryParse(fence[1].trim()); if (out) return out; }
const a = trimmed.indexOf('{'), b = trimmed.lastIndexOf('}');
if (a !== -1 && b > a) return tryParse(trimmed.slice(a, b + 1));
return null;
}
const result = parseResult(process.env.CODEX_RESULT);
if (!result) { core.setFailed('Could not parse Codex output as JSON.'); return; }
const summary = (result.summary || '').trim();
const findings = (Array.isArray(result.findings) ? result.findings : [])
.slice(0, MAX_COMMENTS);
// Build the set of (path -> commentable new-file line numbers) from the diff.
const pr = await github.rest.pulls.get({ owner, repo, pull_number });
const headSha = pr.data.head.sha;
const files = await github.paginate(github.rest.pulls.listFiles, {
owner, repo, pull_number, per_page: 100,
});
const commentable = new Map();
for (const f of files) {
if (!f.patch) continue;
const lines = new Set();
let newLine = 0;
for (const ln of f.patch.split('\n')) {
const h = ln.match(/^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/);
if (h) { newLine = parseInt(h[1], 10); continue; }
if (ln.startsWith('\\')) continue; // "\ No newline at end of file"
if (ln.startsWith('+')) { lines.add(newLine); newLine++; }
else if (ln.startsWith('-')) { /* removed line, no new-side number */ }
else { newLine++; } // context line
}
commentable.set(f.filename, lines);
}
// Split findings into inline-able vs. orphans (lines not in the diff).
const inline = [], orphans = [];
for (const fnd of findings) {
const sev = (fnd.severity || 'consider').toUpperCase();
const set = commentable.get(fnd.path);
if (set && set.has(fnd.line)) {
inline.push({
path: fnd.path, line: fnd.line, side: 'RIGHT',
body: `${INLINE_MARKER}\n**${sev}** ${fnd.comment}`,
});
} else {
orphans.push({ ...fnd, sev });
}
}
// Always clear our prior inline comments first, so findings resolved in a
// later push disappear even when this run produces no inline comments.
try {
const prior = await github.paginate(github.rest.pulls.listReviewComments, {
owner, repo, pull_number, per_page: 100,
});
for (const c of prior) {
if (c.body && c.body.includes(INLINE_MARKER)) {
try { await github.rest.pulls.deleteReviewComment({ owner, repo, comment_id: c.id }); }
catch {}
}
}
} catch (e) { core.warning(`Could not clean prior inline comments: ${e.message}`); }
// Post this run's inline comments. If it fails, fold them into the summary.
let inlinePosted = false;
if (inline.length) {
try {
await github.rest.pulls.createReview({
owner, repo, pull_number, commit_id: headSha,
event: 'COMMENT', comments: inline,
});
inlinePosted = true;
} catch (err) {
core.warning(`Inline review failed (${err.status || ''}); folding into the summary.`);
}
}
// Build the rolling summary comment.
const leftover = inlinePosted
? orphans
: findings.map(f => ({ ...f, sev: (f.severity || 'consider').toUpperCase() }));
let body = `${SUMMARY_MARKER}\n### Codex review\n\n` +
(summary || (findings.length ? 'See inline comments.' : 'No issues found.'));
if (leftover.length) {
body += `\n\n**${inlinePosted ? 'Findings not on changed lines' : 'Findings'}:**\n`;
for (const o of leftover) body += `\n- \`${o.path}:${o.line}\` **${o.sev}** ${o.comment}`;
}
// Upsert one rolling summary comment instead of stacking on each push.
const comments = await github.paginate(github.rest.issues.listComments, {
owner, repo, issue_number: pull_number, per_page: 100,
});
const existing = comments.find(c => c.body && c.body.includes(SUMMARY_MARKER));
if (existing) {
await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body });
} else {
await github.rest.issues.createComment({ owner, repo, issue_number: pull_number, body });
}