Skip to content

docs: simplify the SDK release flow - #386

Open
sjmiller609 wants to merge 2 commits into
mainfrom
hypeship/single-sdk-release-pr
Open

docs: simplify the SDK release flow#386
sjmiller609 wants to merge 2 commits into
mainfrom
hypeship/single-sdk-release-pr

Conversation

@sjmiller609

@sjmiller609 sjmiller609 commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • document the single-PR SDK release flow
  • clarify that validated staging changes accumulate on public next
  • describe merging the versioned nextmain PR as the only manual release action

Testing

  • validated the changed workflow with actionlint
  • checked markdown and configuration diffs for consistency with the SDK release workflows

Rollout

Merge the SDK staging workflow PRs before this PR so the next generation run uses the single-PR flow.


Note

Low Risk
Documentation and comment-only changes with no runtime or workflow logic modified.

Overview
Updates SDK generation docs to match the simplified release model: staging promotion advances public next, and release automation maintains one versioned nextmain PR per SDK (replacing the old stainless/release + release-please steps).

The stlc-generate workflow header and docs/runbooks/sdk-generation-stlc.md now describe accumulating changes on next, merging that release PR with a merge commit to publish, and opening a draft recovery PR on next when promotion hits Git conflicts. Normal API change guidance and the hosted cutover checklist use the same preview → staging → next → release PR → publish → back-sync wording.

Reviewed by Cursor Bugbot for commit 88d4381. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown
-->

✱ stlc build

go code · compare

Your SDK build was successful.

generate ✅bootstrap ✅format ✅

112 files generated at a1834a5 (pushed)

go get github.com/kernel/hypeman-go-staging@a1834a5075405cf86d5db78da214179a0272dc6c
typescript code · compare

Your SDK build was successful.

generate ✅bootstrap ✅format ✅

134 files generated at 8bd3f2d (pushed)

Diagnostics: 💡 0 new / 5 total note
LevelCodeMessageTargets
Build metadata
Buildbd_766sr7FD-hewn-ball
Timestamp2026-08-10T21:37:54.518Z
stlc8413509
Spec hash1fced2594ced
Config hash9125eb22cb4c

This comment is auto-generated by stlc and is kept up to date as you push.
If you push new commits, re-run this workflow to update this comment.
Last updated: 2026-08-10 21:38:12 UTC

@sjmiller609
sjmiller609 marked this pull request as ready for review August 10, 2026 20:42
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