docs: drop the pass-bound operation list from the README #36
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/readme-pass-pointers"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Addresses the round-2 review of #30 (claims
01M44DFBM0FHYZ5WA97BQNM831and01M44DK5FQJDPCKECYQK6GRXSG).The Notes paragraph listed which operations stay pinned to one dispatch pass, and the list was wrong: the wait ends on review-level triage state, and only its coverage poll is pass-scoped. The paragraph is gone. The supersession paragraph under "Outcomes and exit codes" now carries the one fact a user needs from it: the run does not switch to the newer pass. Which reads take a pass id is visible in
ReviewSessionandreview, so the README no longer walks through the call path.The Outcomes pointer now promises only what
src/contract/types.tsholds: the outcome names, a behaviour comment beside each, and the exit codes.Stacked on #30. Merge that first.
🤖 Generated with Claude Code
Review
01M45PF4XK8TJCDZXNZK5TVH5K— head47186d4b703f40791d3c89289f86a451e4bc0dc8Review — j4k-oss/review-wrapper @
edda231e04Scope: diff against base tree
f0bfd434e1a7Status: dispatched — coverage complete (5/5 slots terminal)
Facts: current review-wide projection
Computed under:
Triage stalled: sandbox infrastructure failed.
Findings (0)
No findings survived.
Reviewed:
Other claims
01M45PQPXDGQZQE6AHB7H5K2AYmedium — The action overview duplicates the runtime configuration01M45PRF79E5BJQ1KSVH390T2Flow — The composition paragraph repeats the fork credential boundary01M45PT57VVB8ZZC2T6DXZPDQ0medium — The supersession explanation leaves the findings scope ambiguousCoverage
Coverage pass: 01M45PF4Z1H32G1SJWVY0XWJHR
Accounting: complete
Slot health: healthy
@ -75,1 +73,3 @@service session fails, the log line's remedy comes from `FAILURE_REMEDIES` in`OUTCOMES` in `src/contract/types.ts` names the outcomes, with a comment beside eachthat summarizes its behaviour, and `OUTCOME_EXIT` in the same file maps each outcome toits exit code. The code in `src/wrapper/` and `src/review/` implements that behaviour.low — Outcome implementation pointer omits the code that writes PR results
lens
writing-quality· armdefault· tally 1 valid / 0 invalid / 0 uncertainclaim
01M44EXHKNX93Z0YG77V0NAFD9of review01M44ERGWEPRBBND3J1KWTH8B3Fixed in
48edb16. I removed the sentence.OUTCOMESandOUTCOME_EXITremain the pointer for what each outcome does, so the README no longer names a partial set of directories as the implementation.This is review
01M44ERGWEPRBBND3J1KWTH8B3of9753c59. Its inline finding is fixed in48edb16and answered in its thread.The unadjudicated claim
01M44EYK0QZ9K6K0T9FN93PX42("Supersession note overstates the scope of unpinned reads") is valid and also fixed in48edb16. "Every other read is review-wide" covered the forge read that checks whether the head moved. The note now says that the service reads that take no pass id (the review, its findings and its claims) cover the whole review.getReview,getFindingsandlistClaimsare those reads.@ -164,1 +163,4 @@dispatch becomes latest. Claims, findings, and triage settlement remain review-wide facts.Supersession does not move the run to the newer pass. `review` in`src/wrapper/orchestrator.ts` pins one pass (`pinnedPassId`) and hands it to the stepsthat take a pass id. The service reads that take no pass id (the review, its findings andits claims) cover the whole review.medium — Supersession note copies the no-pass-id service read set
lens
restated-sets· armdefault· tally 1 valid / 0 invalid / 0 uncertainclaim
01M44G1YXHNCHW8J2PJ0ZP2W47of review01M44FVDVZRWK3M0P3P51P4FHVlow — Supersession note duplicates the wrapper call path in README
lens
project-docs· armdefault· tally 1 valid / 0 invalid / 0 uncertainclaim
01M44G49XEAQ08P5GXRJDR26Q1of review01M44FVDVZRWK3M0P3P51P4FHVFixed in
25c3d9c. The parenthetical list of no-pass-id reads is gone with the rest of that Notes paragraph;ReviewSessionremains the only place that says which reads take a pass id.Fixed in
25c3d9c. The call-path walkthrough is gone. The supersession paragraph under "Outcomes and exit codes" keeps the user-facing consequence: the run does not switch to the newer pass.docs: point the supersession note at the pinned-pass flowto docs: drop the pass-bound operation list from the READMEThis is review
01M44FVDVZRWK3M0P3P51P4FHVof48edb16. Its two inline findings are fixed in25c3d9cand answered in their threads;01M44G31Q7QMYAFPWAD1QFJ9QHis the service's duplicate of the first. The other four findings are summary-only and about README text this PR doesn't change. Each is valid, and the PR that owns that text already handles it:01M44G3HTGPNGMJMBT8SBYN3KB("Required environment variable list duplicates the code's required set"): #32 replaces the list with a pointer toforgeCredentials,readWrapperInputsandsrc/main.ts.01M44G3YQK9CPVGRKQNNS9YPFH("Composition paragraph copies the reconciler count and names"): #32 points atWrapperDepsinstead.01M44G54JASB7FK86VJACP57ME("Recovery table duplicates the failure messages and remedies in the job log") and01M44G608G6EEP9MJFK3BQDMMM("Action input table restates action.yml"): #34 replaces both tables, the recovery table with the remedy printed on the failure log line and the input table with a pointer toaction.yml.@ -77,4 +78,5 @@comes from `formatStuckRemedy` and `formatExecutionRecovery` in `src/wrapper/remedies.ts`.Supersession, a newer dispatch pass becoming latest during the wait, is a flag on`WaitResult`, not an outcome. It never changes the exit code.`WaitResult`, not an outcome. It never changes the exit code, and the run does not switchto the newer pass.medium — Supersession wording implies all subsequent reads stay on the pinned pass
lens
writing-quality· armdefault· tally 1 valid / 0 invalid / 0 uncertainclaim
01M44GSJ5ZH4XAFCBMFQ26DDBBof review01M44GNBZGWES4QQP6295GRM6HValid. The clause is true, since the run never changes its pinned pass, but it doesn't say that only the requests taking a pass id are pinned. This PR is in its third review round and the wording doesn't defeat its pointer change, so #38, stacked on this PR, rewrites the sentence: requests that take a pass id keep the selected pass, the other reads return review-wide state, and
ReviewSessioninsrc/contract/types.tsshows which requests take one.25c3d9c85247186d4b70