docs: release runbook for the multi-distribution layout - #153
Merged
Conversation
The repository publishes more than one PyPI distribution from one source tree, and nothing recorded how that works. Every release would have meant re-deriving it from the workflow. RELEASE.md covers the layout, why the bootstrap and adapters version on separate axes, how a tag selects a distribution and its manifest, the single-distribution and whole-workspace procedures, what has to be set up on PyPI before a new adapter's first release, what each failure message means, and how to verify a release from PyPI rather than from CI. Also fixes the README's install instructions, which still said `pip install span-panel-api` alone. On this branch that produces a client with no parser that connects and then raises SpanPanelAdapterMissingError.
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
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.
Adds
RELEASE.md. Nothing recorded how releasing works now that this repopublishes two PyPI distributions from one source tree, so every release meant
re-deriving it from
release.yml.What it covers
releasing (own version, own PyPI project, one release publishes one package).
adapter on its library API with the wire format declared by
SUPPORTS_DATA_MODEL_VERSIONSrather than the version number.example, and why
schema-1-v0.1.0will resolve with no workflow edit.bump-commit-then-tag.
latter being the "how does an admin release everything" answer: a sequence of
single releases, bootstrap first, with the dependency-floor caveat.
most likely to be forgotten when
schema-1lands.install — the entry-point seam only exists across a real package boundary.
--preon PyPI, the checkbox on GitHub, and that theworkflow is indifferent.
Also
DEVELOPMENT.mdgains a workspace-layout section and a pointer to the runbook.pip install span-panel-apialone, which on this branch gives a client withno parser that connects and then raises
SpanPanelAdapterMissingError.Known remaining doc staleness (not addressed here)
The README's Architecture section still describes
HomiePropertyAccumulatorand
HomieLifecycleas part of this package. They moved tospan_panel_api_schema_0in Phase 1 and are no longer exported, which thechangelog records but the README contradicts. That is a substantive rewrite of
a section rather than a correction, so it is called out rather than folded in.