fix(review-pr): anchor findings to diff lines
The gitea posting snippet used the issue-comment endpoint, which has no path or line, so findings named `path:line` in prose instead of landing on the code. Both forges now post one COMMENT review carrying anchored findings in comments[] and loose ones in the body. land's gitea baseline missed review-comment ids, which would replay every code comment on the first hint. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
+40
-15
@@ -62,43 +62,68 @@ than reviewing hunks in isolation.
|
||||
|
||||
**Write the findings** to `<git-dir>/pr-<N>-findings.md` — in the git
|
||||
dir, not the working tree, so nothing lands in the branch under review.
|
||||
One finding per entry: `path:line`, what's wrong, what to do. No praise,
|
||||
no summary of what the PR does, no severity theatre. If you find
|
||||
nothing, say so in one line.
|
||||
One finding per entry: `path:line`, what's wrong, what to do — and mark
|
||||
whether it anchors to a diff line or is a loose remark about the change
|
||||
as a whole, which decides where it goes in §2. No praise, no summary of
|
||||
what the PR does, no severity theatre. If you find nothing, say so in
|
||||
one line.
|
||||
|
||||
Then follow the mode: post (gitea) or report the file to the user and
|
||||
stop (github).
|
||||
|
||||
## 2. Posting
|
||||
|
||||
Post **one review** per pass, never a stream of separate comments. A
|
||||
review carries two kinds of finding at once:
|
||||
|
||||
- **Anchored** — the finding is about a specific line in the diff. It
|
||||
belongs in `comments[]` with a `path` and a line, so it renders on
|
||||
the code.
|
||||
- **Loose** — the finding is about the change as a whole, or about code
|
||||
the diff doesn't touch, or it has no single line to sit on. It goes
|
||||
in the review `body`.
|
||||
|
||||
Anchor whatever can be anchored. Writing `path:line` into prose when
|
||||
the API would have put the comment on that line is the failure mode
|
||||
this section exists to prevent.
|
||||
|
||||
Only after the user's go-ahead on gated repos. Record every id you post
|
||||
in the same step, or the next hint reads your own review as new
|
||||
feedback:
|
||||
|
||||
```bash
|
||||
# gitea
|
||||
rid=$(curl -sS -X POST -H "Authorization: token $GITEA_TOKEN" -H "Content-Type: application/json" \
|
||||
"$BASE/api/v1/repos/$REPO/issues/$N/comments" -d "$(jq -nc --arg body "<finding>" '{body:$body}')" | jq -r .id)
|
||||
# gitea — body is the loose findings, comments[] the anchored ones
|
||||
# new_position = line in the new file; use old_position for a removed line
|
||||
rid=$(jq -nc \
|
||||
--arg body "<loose findings, or empty>" \
|
||||
--argjson comments '[{"path":"path/to/file.ts","new_position":11,"body":"<finding>"}]' \
|
||||
'{event:"COMMENT", body:$body, comments:$comments}' \
|
||||
| curl -sS -X POST -H "Authorization: token $GITEA_TOKEN" -H "Content-Type: application/json" \
|
||||
"$BASE/api/v1/repos/$REPO/pulls/$N/reviews" -d @- | jq -r .id)
|
||||
echo "$rid" >> "$seen"
|
||||
curl -sS -H "Authorization: token $GITEA_TOKEN" \
|
||||
"$BASE/api/v1/repos/$REPO/pulls/$N/reviews/$rid/comments" | jq -r '.[].id' >> "$seen"
|
||||
```
|
||||
|
||||
```bash
|
||||
# github, after approval
|
||||
rid=$(gh api repos/<OWNER>/<REPO>/pulls/<N>/comments -f body="<finding>" \
|
||||
-f commit_id=<sha> -f path=<path> -F line=<line> --jq .id)
|
||||
echo "$rid" >> "$seen"
|
||||
# github, after approval — same shape, `line` instead of new_position
|
||||
jq -nc --arg body "<loose findings, or empty>" \
|
||||
--argjson comments '[{"path":"path/to/file.ts","line":11,"body":"<finding>"}]' \
|
||||
'{event:"COMMENT", commit_id:"<sha>", body:$body, comments:$comments}' \
|
||||
| gh api repos/<OWNER>/<REPO>/pulls/<N>/reviews --input - --jq .id >> "$seen"
|
||||
gh api repos/<OWNER>/<REPO>/pulls/<N>/comments --jq '.[].id' >> "$seen"
|
||||
```
|
||||
|
||||
Prefer one review with several comments over a stream of separate
|
||||
comments. **Never approve and never request changes as a review
|
||||
decision** — that's the user's call on someone else's PR, and it carries
|
||||
weight your findings don't.
|
||||
`event: "COMMENT"` is the only event either forge should see from you.
|
||||
**Never approve and never request changes as a review decision** —
|
||||
that's the user's call on someone else's PR, and it carries weight your
|
||||
findings don't.
|
||||
|
||||
## 3. Handling a hint
|
||||
|
||||
| reason | what to do |
|
||||
| --- | --- |
|
||||
| `comments` | Read comments not in the seen file. Someone replying to a finding gets an answer; a new comment thread may need a fresh look at that code. Record every id you handle or post. |
|
||||
| `comments` | Read comments not in the seen file. Someone replying to a finding gets an answer; a new comment thread may need a fresh look at that code. Reply in the thread it came from: on github, `POST /pulls/<N>/comments/<cid>/replies`; on gitea there is no reply endpoint, so post a review whose `comments[]` entry carries the same `path` and line — gitea groups code comments by position into one conversation. A loose reply goes to `POST /issues/<N>/comments`. Record every id you handle or post. |
|
||||
| `ci` | New head SHA: the author pushed. Re-read the diff for the new commits only, and check whether your open findings are addressed. Do not investigate their CI failures — not your PR. |
|
||||
| `state` | Merged or closed: write the outcome to the state file and stop. Draft flips: nothing to do. |
|
||||
| `conflicts` | Nothing to do. The author resolves conflicts on their own branch. |
|
||||
|
||||
Reference in New Issue
Block a user