Review A Branch
Use homeboy review when you need the PR-shaped quality gate for a branch. It runs scoped audit, lint, and test checks against the same changed-file set and reports one consolidated result.
Use This When
- You want to know whether a branch is review-ready.
- You need one proof artifact instead of separate audit, lint, and test logs.
- A coding agent needs a stable JSON result to inspect.
- A PR comment should summarize the branch status for reviewers.
1. Pick The Base Ref
Scope the review to what a reviewer will see. For most branches, that is the default branch:
homeboy review --changed-since origin/mainUse another base when the branch is stacked or cut from a release tag:
homeboy review my-component --changed-since origin/trunk
homeboy review my-component --changed-since v1.2.0Use --changed-only only for a quick local check of the current working tree. Use --changed-since for reviewer-facing proof.
2. Capture The Result
For a human terminal run:
homeboy review my-component --changed-since origin/mainFor CI or agent handoff, write the structured envelope:
homeboy --output homeboy-results/review.json
review my-component --changed-since origin/main --summaryFor a PR-comment body:
homeboy review my-component
--changed-since origin/main
--report pr-comment > homeboy-results/review-comment.md3. Read Failures
Treat review as the summary layer. When one stage fails, deep dive with the same scope:
homeboy review audit my-component --changed-since origin/main
homeboy review lint my-component --changed-since origin/main
homeboy review test my-component --changed-since origin/mainThe goal is to keep the final reviewer-facing proof as homeboy review, while using individual stages for diagnosis.
4. Add A Declared CI Profile When Needed
If the component declares a CI profile, include it as an additional review stage:
homeboy review my-component --changed-since origin/main --ci-profile prreview --ci-profile runs declared Homeboy CI profiles. It does not attempt to interpret arbitrary provider YAML.
5. Use Runner Proof For Hot Gates
For release-gate proof, use normal routing and avoid local-hot bypasses:
homeboy --runner <runner-id> review my-component --changed-since origin/mainSee Release-gate proof path when the proof must be non-local and reviewer-safe.
Expected Outputs
- Terminal summary for humans.
- Optional JSON envelope at the path passed to
--output. - Optional Markdown PR-comment section when
--report pr-commentis used. - Stage-specific deep-dive commands when a failure needs investigation.