Skip to content

docs(sdkclient): drop build-ladder references from comments - #94

Merged
robbycochran merged 1 commit into
mainfrom
rc-pr1-comment-cleanup
Aug 22, 2026
Merged

docs(sdkclient): drop build-ladder references from comments#94
robbycochran merged 1 commit into
mainfrom
rc-pr1-comment-cleanup

Conversation

@robbycochran

@robbycochran robbycochran commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

Follow-up cleanup to PR1 (SDK foundation). Rewrites comments in internal/openshell/sdkclient that referenced the implementation plan into durable, designed-today form.

Removed sediment: slice numbers (S1/S3/S4), "S3 has landed", "in S4", "see specs findings", TODO(PR8), "S1 kill-gate".

Durable facts preserved:

  • The SA-OIDC dial path is untested end-to-end because no OIDC gateway is available in this environment (audience/scopes unverified).
  • TestHealthE2E proves an mTLS Health().Check from within the harness module against a live gateway.

Comment-only (plus one t.Skip message reword); no behavior change. build/vet/full test suite/golangci-lint all green.

Note: "Phase 2" in cmd/doctor.go is intentionally kept — it is user-facing product vocabulary (the doctor --help documents "Phase 1 (offline)" / "Phase 2 (online)"), not a plan reference.

Summary by CodeRabbit

  • Documentation
    • Clarified verification coverage for mTLS, default authentication, and service-account OIDC connections.
    • Documented that live OIDC gateway dialing remains untested.
    • Updated health check test documentation and skip messaging to reflect current verification terminology.

Rewrite comments that referenced the implementation plan (slice numbers S1/S3/S4,
"has landed", "see specs findings", TODO(PR8), "kill-gate") into durable
form. The real maintenance facts are preserved: the SA-OIDC dial path is untested
end-to-end because no OIDC gateway is available in this environment, and the
E2E health test proves mTLS Health from within the module against a live gateway.
Comment-only; no behavior change.
@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9d536151-ff5c-4f9b-a22a-b375e885a911

📥 Commits

Reviewing files that changed from the base of the PR and between 029d96d and ce07e00.

📒 Files selected for processing (3)
  • internal/openshell/sdkclient/auth.go
  • internal/openshell/sdkclient/client.go
  • internal/openshell/sdkclient/health_e2e_test.go

Included review availability: Your plan provides up to 12 included reviews per hour; 9 remain after this review.


Walkthrough

Changes

SDK client documentation

Layer / File(s) Summary
Authentication coverage documentation
internal/openshell/sdkclient/auth.go, internal/openshell/sdkclient/client.go
Comments now identify verified mTLS coverage and untested SA-OIDC live dialing. They also document audience and scope verification status.
Health test documentation
internal/openshell/sdkclient/health_e2e_test.go
The test comment and skip message no longer reference the “S1 kill-gate.”

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to ce07e

This is a localized documentation cleanup with no behavior change, and the stated build, vet, test, and lint checks are green; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the removal of build-ladder and implementation-plan references from sdkclient comments.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rc-pr1-comment-cleanup

Comment @coderabbitai help to get the list of available commands.

@robbycochran
robbycochran merged commit 894b542 into main Aug 22, 2026
7 checks passed
@robbycochran
robbycochran deleted the rc-pr1-comment-cleanup branch August 22, 2026 01:55
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.

1 participant