Skip to content

Write the end-to-end NCode Review setup runbook - #239

Merged
polewskm merged 11 commits into
mainfrom
worktree-issue-237
Nov 21, 2026
Merged

polewskm merged 11 commits into
mainfrom
worktree-issue-237

Conversation

@polewskm

Copy link
Copy Markdown
Contributor

Adds docs/setup.md, one runbook a maintainer follows top to bottom to set NCode Review up: once per organization (gh's scopes, the NCode Review and NCode Review Approver apps, Anthropic's workload identity federation, the organization secrets), once per repository (the approver's installation and key, code-review.yml's approval inputs, requiring the approval, checking it), the private keys, how a review behaves, and troubleshooting for each error met so far. Each step says who does it, where, what to check afterwards and what goes wrong.
README.md and docs/README.md link the runbook; the README's sections stay the reference. The README's Using it caller also pins v1.5.0 and passes approve: true and approver-private-key in its review job, and the Interface's "A caller needs" list names the optional NCODE_REVIEW_APPROVER_PRIVATE_KEY environment secret.
Docs only: no Release: line, and the changelog entries wait under ## [Unreleased].

Protected paths changed:
none

Closes #237
Refs #232
Refs #236
Refs NCodeGroup/project-template#460
Refs NCodeGroup/project-template#468

@polewskm

Copy link
Copy Markdown
Contributor Author

/review

@ncode-review-approver ncode-review-approver Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved at e16f8d6: no blocker or should-fix finding remains.

@ncode-review

ncode-review Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

🤖 Review complete

Verdict: ✅ Approve — Light review (documentation only): No findings.

Approval: Approved — no blocker or should-fix finding remains.

1 reviewer run — 0 findings (run details)

Reviewer Model Findings Top
hygiene haiku-5-5 0 🟢

Skipped: api-compat, architecture, completeness, conventions, correctness, data-model, infrastructure, intent, performance, security, tests

Trial: findings are posted as review threads and in the check run. $0.01 on Amazon Bedrock, 26s, at e16f8d6. (how to interact)

📋 Outcomes

Merged at e16f8d6. No findings were posted as threads.

@polewskm polewskm self-assigned this Nov 21, 2026
@polewskm
polewskm marked this pull request as ready for review November 21, 2026 20:37
@polewskm
polewskm deployed to code-review November 21, 2026 20:37 — with GitHub Actions Active
@polewskm
polewskm merged commit 8775b79 into main Nov 21, 2026
9 of 10 checks passed
@polewskm
polewskm deleted the worktree-issue-237 branch November 21, 2026 20:38

This branch was successfully deployed

1 active deployment
code-review — e16f8d65 Deployed Nov 21, 2026 by polewskm via review #815
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document every manual step to set up NCode Review, end to end, in one runbook

1 participant