ci: support release candidate publishing and PEP 440 release validation - #309
Draft
jplbrun wants to merge 2 commits into
Draft
ci: support release candidate publishing and PEP 440 release validation#309jplbrun wants to merge 2 commits into
jplbrun wants to merge 2 commits into
Conversation
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.
Description
Hardens and documents the existing support for publishing release candidates (RCs) to PyPI, and updates the version-bump automation to understand PEP 440 pre-release versions.
Previously the version-bump check used
sort -V, which incorrectly treats1.0.0rc1as newer than the final1.0.0. When the check ran for a source-changing PR, it could therefore misclassify an RC-to-final promotion as a regression. The release workflow also did not validate the release tag or the GitHub pre-release setting.This PR:
sort -Vcomparison incheck-version-bump.yamlwith a Python script (check_version_bump.py) that uses PEP 440 ordering, so1.0.0rc1 -> 1.0.0is accepted and regressions are still rejected.release.yml(validate_release.py) that fails the publish before build if any of these are wrong: the version is not normalized PEP 440, the tag does not equalv<version>, or the GitHub pre-release setting does not match whether the version is a pre-release.tests/ci/.docs/RELEASE.mdwith the RC cycle, the pre-release/latest guidance, and RC install instructions.Related Issue
N/A
Type of Change
How to Test
uv run pytest tests/ci/test_versioning_scripts.py -v.1.0.0rc1 -> 1.0.0and rejects1.0.0 -> 1.0.0rc1(regression).validate_release.pyrejects a tag/version mismatch and a pre-release-flag mismatch, and accepts matching metadata for both an RC and a stable version.Expected result: the RC-to-final bump is accepted, mismatched release metadata fails before publishing, and correct metadata passes.
Checklist
Breaking Changes
None
Additional Notes
N/A