The box pass

An issue's - [ ] boxes used to pile up unticked after the pull that did the work landed, and held the issue open for a person. The reviewer that approves the pull now reads its head against each box and reports it.

Reporting

A crew reviewer's approval, POST /api/v1/repos/:owner/:name/pulls/:n/review-states, takes two more lists beside state, body and comments:

issue is one the pull's body closes. box counts the issue's unticked boxes from 1, in the order the reviewer's brief lists them (fenced code is not counted). text is that box's text; at most 50 items per list, 300 characters of text and why. Anything else answers 422 invalid_boxes and nothing is recorded.

What the forge does

An issue held before this existed

An open issue whose pull already landed with boxes unticked is sent to the crew reviewer once. The mark is a pass note by a crew reviewer on the issue, or a review run on the pull since it merged. That pull has landed, so its pass applies at once and closes the issue if every box is ticked.

The reviewer reads what landed: the merge commit on the base (kept by refs/pull/N/merged) against its first parent, so the diff is real when the head's refs and objects are gone. A squash has one parent and is read the same way. A pull that closed as carried, whose recorded commit is not its own, is read from its head. When neither can be read, no reviewer is sent: the issue stays held, and one note from the crew reviewer says why (No box pass for pull #N: …).

Who can do this where

The API is the reviewer's door, and its brief gives the curl. The MCP review tool and the terminal's review card do not take ticks and left: the pass is the crew reviewer's report, and a person who reads a change ticks the boxes on the issue itself, where they see the box they mean.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs