forge notify docs: rewrite the inline comments section for the prose lint
This commit is contained in:
parent
c6958c7baa
commit
e334513244
1 changed files with 15 additions and 13 deletions
|
|
@ -301,22 +301,24 @@ with the meta-suffix `reviewer:` line (requested reviewers, below).
|
||||||
### Inline review comments
|
### Inline review comments
|
||||||
|
|
||||||
A review's line comments belong to neither the review body nor the
|
A review's line comments belong to neither the review body nor the
|
||||||
`latest_comment_url` (a review with only inline comments has no such url
|
`latest_comment_url`. A review with only inline comments has no such url
|
||||||
and otherwise lands as a bare `activity on PR`). So every PR wake fetches
|
and would otherwise land as a bare `activity on PR`. Every PR wake therefore
|
||||||
the PR's reviews (`/pulls/N/reviews`, up to four pages of 50) and, for the
|
fetches the PR's reviews (`/pulls/N/reviews`, up to four pages of 50) and,
|
||||||
reviews new to the agent, appends an
|
for the reviews new to the agent, appends an
|
||||||
`inline review comments (read them with `hive-forge pr reviews N`):` block
|
`inline review comments (read them with `hive-forge pr reviews N`):` block
|
||||||
saying where they are: one `author: path:line, path, ...` line per review
|
saying where they sit: one `author: path:line, path, ...` line per review
|
||||||
author (bare `path` when Forgejo dropped the position because the line left
|
author (bare `path` when Forgejo dropped the position because the line left
|
||||||
the diff; control characters in a path become spaces). The comment text stays
|
the diff; control characters in a path become spaces). The comment text stays
|
||||||
out of the wake - the agent reads the full review with the CLI. A review
|
out of the wake, and the agent reads the full review with the CLI.
|
||||||
counts as new when it was submitted strictly after the thread's previously
|
|
||||||
delivered `updated_at` (all of them without a baseline, and any with no
|
A review counts as new when it landed strictly after the thread's previously
|
||||||
submit time, so nothing is hidden), is not the agent's own, is not a
|
delivered `updated_at`. Without a baseline every review counts, and so does
|
||||||
`PENDING` draft, and has `comments_count > 0`. Only the newest 5 such reviews
|
one with no submit time, so nothing disappears. It doesn't count when the
|
||||||
are fetched and at most 10 locations are listed (`(+N more)` for the rest).
|
agent wrote it, when it's a `PENDING` draft, or when `comments_count` is 0.
|
||||||
Best effort: a failed fetch yields less text, never a dropped wake. Cost: one
|
The notifier fetches the newest 5 such reviews and lists at most 10 locations
|
||||||
reviews fetch per PR wake, plus one per new commented review.
|
(`(+N more)` for the rest). Best effort: a failed fetch yields less text and
|
||||||
|
never drops the wake. Cost: one reviews fetch per PR wake, plus one per new
|
||||||
|
commented review.
|
||||||
|
|
||||||
### Merge/close vs a later comment
|
### Merge/close vs a later comment
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue