Skip to content

chore(sdk/ts): freeze core SDK changes at v0.1.9 #5684

Closed

Description

@pimlock

User Story

As the maintainer moving OpenShell's TypeScript SDK to ai-openshell/sdk-typescript, I need core PRs to stop changing the imported SDK so that the two repositories do not diverge after the v0.1.9 import.

Problem Statement

Core still accepts changes under sdk/typescript/ and runs SDK build checks on PRs. The standalone repository imports that history and generates bindings from a pinned core release, so later core SDK edits require another manual import.

Impact / Why This Matters

SDK changes can land in the wrong repository and invalidate the migration snapshot. Manually checking every core PR does not enforce the freeze or tell contributors where to send their changes.

Proposed Design

Reject core PRs that add or modify sdk/typescript/, with a diagnostic directing SDK PRs to https://github.com/ai-openshell/sdk-typescript. Permit deletions for the later removal. Core proto PRs need no generated TypeScript bindings here. Remove SDK tasks from core PR checks and aggregate checks, and run protobuf lint with core's pinned Buf tool. Retain core release publication until the separate publishing cutover.

Acceptance Criteria

  • Branch Checks rejects added or modified TypeScript SDK files and identifies the destination repository.
  • Deletions and core-only proto changes pass the freeze check.
  • Core PR checks and aggregate checks no longer build, format, lint, or test the SDK.
  • Protobuf lint runs without installing SDK dependencies.
  • Contributor and agent guidance describes the freeze and destination.

Alternatives Considered

  • Keep importing subsequent core SDK changes. This requires manual reconciliation and delays ownership transfer.
  • Remove the SDK and publisher immediately. The standalone release automation is a separate cutover step.

Context

Part of #5480. The history refresh and standalone build are ai-openshell/sdk-typescript#1 and ai-openshell/sdk-typescript#2. This issue covers only the core freeze and PR-check cutover.

Activity

  1. pimlock commented on Nov 20, 2026

    @pimlock
    ContributorAuthor

    v0.1.10 TypeScript SDK cutover checklist

    @nvidia/openshell-sdk@0.1.10 is the last release of the old package: a stub that re-exports @ai-openshell/sdk@^0.1.0. @ai-openshell/sdk@0.1.10 can only be released after core tags v0.1.10, so the core Release workflow doesn't publish the stub. We publish it by hand after the SDK release.

    Before tagging v0.1.10

    After core tags v0.1.10

    • Core Release finishes green. It no longer runs or expects publish-sdk-typescript.
    • sdk-typescript core-watch opens the chore(core): track v0.1.10 PR (hourly at :17, or dispatch it with tag=v0.1.10). Merge it.
    • sdk-typescript release publishes @ai-openshell/sdk@0.1.10 to npmjs.org with provenance.
    • Check that @ai-openshell/sdk@0.1.10 exports SandboxRef.applicationServiceUrls and gatewayServiceUrls, and that the generated types are reachable from both the root and /raw entry points.
    • Dispatch Publish TypeScript SDK in core on main with release-tag=v0.1.10, npm-version=0.1.10, make-latest=true. It fails without publishing if npmjs.org has no @ai-openshell/sdk@^0.1.0.
    • In a clean project, npm install @nvidia/openshell-sdk@0.1.10 resolves @ai-openshell/sdk@0.1.10, and imports from @nvidia/openshell-sdk and @nvidia/openshell-sdk/raw work.
    • Update the chore(sdk/ts): migrate the TypeScript SDK to ai-openshell/sdk-typescript #5480 status board.

    After the release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions