feat(release): attach OpenAPI spec to GitHub releases#294
Merged
Conversation
Fulfils the ADR 0020 clause that the canonical spec be attached to releases for version pinning. build-wheel generates spec/openapi-<version>.json (clean tag version, kept out of dist/ so it never reaches PyPI) and uploads it as an artifact; create-release downloads it and adds spec/*.json to the release files. The rc48 release was patched manually; this automates it for future cuts.
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
Fulfils the ADR 0020 clause that the canonical OpenAPI spec be attached to GitHub Releases for version pinning — which the original #292 implementation missed (the
create-releasejob only uploadeddist/*, and the spec lives atdocs/api/openapi.json).build-wheelgeneratesspec/openapi-<version>.jsonfromapp.openapi()(clean tag version;--extra allso all imports resolve) and uploads it as a separateopenapi-specartifact — kept out ofdist/so it never reaches PyPI/twine.create-releasedownloads it and addsspec/*.jsonto the releasefiles.The current
smartem-decisions-v0.1.1rc48release was patched by hand (openapi-0.1.1rc48.jsonis attached now); this makes it automatic for every future cut.Test plan