docs: add release runbook for server/SDK version sync#730
Merged
Conversation
Captures the multi-repo dependency graph (server -> BSR -> proto packages -> Go/Python SDKs; GraphQL schema as the one hand-maintained, undetected drift source), release ordering, pre-release checklist, and the verification bar that would have caught every cross-repo bug found in this project's actual history (pagination schema drift, a removed field SDKs kept sending, stale vendored proto stubs, an unresolvable Go module path, a missing PyPI publish secret).
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
1 participant
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.
Summary
A runbook (
docs/release-runbook.md) documenting how the server and its 5 satellite repos (3 SDKs + 2 dedicated proto packages) need to be released in sync, based on the actual incident history from this project — every "known drift source" listed is a real bug that shipped, not a hypothetical.Covers:
authorizer-jsstays hand-typed rather than adopting generated proto types (a real snake_case/camelCase mismatch with this server's REST config, not an oversight)e2e-playground/sdk-tests/) and when to add to itTest plan