Add README badges and release-workflow test gate - #113
Merged
Conversation
Mirror magpie#75: add CI status and version badges to README, and gate the release build on a green test suite so a broken tag push is caught before it produces artifacts. - README.md: CI + version badges under the H1 - release.yml: uv sync --extra dev + uv run pytest -q before uv build, with SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0 pinning the test environment
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.
Summary
Mirrors magpie#75. Two polish items:
# VesperH1. The CI badge links to theci.ymlworkflow runs; the version shield usesgithub/v/tag(consistent with the README's existing@v0.1.0install example, and accurate now that tags exist but no GitHub Releases are published yet).uv sync --extra devanduv run pytest -qsteps torelease.ymlbeforeuv build, so a broken tag push is caught before it produces artifacts. Both steps setSETUPTOOLS_SCM_PRETEND_VERSION: "0.0.0"to pin the test environment to a stable version; the real tag-derived version is used only by theuv buildstep (which does NOT set the env var).No source code, packaging metadata, or lockfile changes.
ci.ymlis untouched (it already runs the full ruff/mypy/pytest gate).Verification
All run locally on
ci/readme-badges-release-test-gate(2 commits pastv0.1.0):Build artifacts cleaned up before commit; only
README.mdand.github/workflows/release.ymlare staged.