Upstream PR Preparation [Spec] - #30
Conversation
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
Assisted-By: 🤖 Claude Code
|
Warning Review limit reached
Next review available in: 26 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughAdded planning and specification documentation for upstreaming the Go SDK into the OpenShell monorepo, including repository mapping, module migration, examples extraction, Fern docs, CI automation, execution tasks, verification steps, and review checklists. ChangesUpstream PR planning
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #30 +/- ##
==========================================
+ Coverage 88.51% 88.63% +0.12%
==========================================
Files 70 70
Lines 4163 4163
==========================================
+ Hits 3685 3690 +5
+ Misses 330 325 -5
Partials 148 148 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Applied fixes from bot review comments: - Comment #3563837973: Fix DCO sign-off name spelling (Huss -> Huß) in T031 - Comment #3563844937: Ensure replace directive removed before pushing examples repo in T016/T018 - Comment #3563839677: Use portable sed -i.bak syntax in quickstart.md - Comment #3563844934: Use portable sed -i.bak syntax in quickstart.md (duplicate) - Comment #3563844927: Downgrade gate result from PASS to CHECK (secret scan pending) - Comment #3563839654: Uncheck inapplicable checklist items (spec is inherently technical) - Comment #3563839661: Uncheck technology-agnostic success criteria checklist item - Comment #3563839667: Uncheck no-implementation-details checklist item Assisted-By: 🤖 Claude Code
Applied fixes from local CodeRabbit review (remote was rate-limited): - Clarify docs/ exclusion scope in FR-011 (mdbook only, not Fern MDX) - Add proto:gen step to quickstart.md before go mod tidy - Align proto task names in research.md (go:proto vs go:proto:check) - Clarify examples repo bootstrap strategy in T018 Assisted-By: 🤖 Claude Code
- Comment #3563869706: Mark brainstorm 024 as specified with spec 019 Assisted-By: 🤖 Claude Code
Why This Change
The OpenShell Go SDK has been developed in a standalone repository
(
rhuss/openshell-sdk-go) providing typed gRPC clients for the gatewayand edge APIs, in-memory fakes for testing, and OIDC authentication.
Upstream issue #2044
requests contributing this SDK into the
NVIDIA/OpenShellmonorepo undersdk/go/. Without this contribution, Go developers must discover anddepend on a personal fork rather than the official project.
What Changes
The Go SDK source is relocated into the upstream repo at
sdk/go/withits module path rewritten from
github.com/rhuss/openshell-sdk-gotogithub.com/NVIDIA/OpenShell/sdk/go. The 4,649-LOC oshell TUI exampleis extracted to a separate repository (
rhuss/openshell-examples) tokeep the PR focused on library code. Four concise Fern MDX documentation
pages are added under
docs/sdks/go/. A Go CI job and proto freshnesscheck are added to the existing branch-checks workflow. The PR is
delivered as a single squashed draft commit referencing issue #2044.
How It Works
The implementation proceeds in three phases:
Module path migration: Mechanical
sedreplacement of the modulepath in
go.mod, all.gofiles, and the mise proto generationscripts. Proto bindings are regenerated under the new module. Build
and test verification confirms zero regressions.
Documentation and CI: Fern MDX pages (getting-started, architecture,
error-handling, authentication) are created under
docs/sdks/go/andwired into the docs navigation. A
tasks/go.tomlmise task wrapsproto generation for the monorepo context. A Go job is added to
branch-checks.ymlfollowing the existing Rust/Python pattern(checkout, mise install, lint, build, test, proto:check).
PR assembly: Internal artifacts (brainstorms, spec-kit config,
Claude Code config) are excluded. Design specs are included under
sdk/go/specs/with an explicit question to upstream maintainersabout whether to retain them. All changes are squashed into a single
DCO-signed commit.
Important
Review Guide contains the full review guidance: key decisions, scope boundaries, areas needing attention, and review checklist.
This PR contains the specification artifacts for Upstream PR Preparation. Implementation follows after spec approval.
Assisted-By: 🤖 Claude Code
Summary by CodeRabbit