Repository navigation
Write the end-to-end NCode Review setup runbook - #239
Merged
Merged
Conversation
Contributor
Author
|
/review |
There was a problem hiding this comment.
Approved at e16f8d6: no blocker or should-fix finding remains.
🤖 Review completeVerdict: ✅ Approve — Light review (documentation only): No findings. Approval: Approved — no blocker or should-fix finding remains. 1 reviewer run — 0 findings (run details)
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) 📋 OutcomesMerged at e16f8d6. No findings were posted as threads. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdanddocs/README.mdlink the runbook; the README's sections stay the reference. The README's Using it caller also pins v1.5.0 and passesapprove: trueandapprover-private-keyin its review job, and the Interface's "A caller needs" list names the optionalNCODE_REVIEW_APPROVER_PRIVATE_KEYenvironment 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