Make development auto-generated package versions PEP 440 compliant #85
Conversation
This file contains 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
Out of the box, setuptools_scm generates development package versions in a format that doesn't comply with PEP 440, so the test-pypi publish workflow failed. That's by design, to prevent dev releases going to PyPI. However, our prod PyPI workflow will trigger only when a tag in the format v[0-9].[0-9].[0-9] is pushed to GitHub, so the liklihood of inadvertently publishing a dev version to PyPI is low.
zkamvar
approved these changes
Jan 10, 2025
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.
Out of the box, setuptools_scm generates development package versions in a format that doesn't comply with PEP 440, so the test-pypi publish workflow failed.
That's by design, to prevent dev releases going to PyPI. However, our prod PyPI workflow will trigger only when a tag in the format v[0-9].[0-9].[0-9] is pushed to GitHub, so the liklihood of inadvertently publishing a dev version to PyPI is low.
I also pushed my local v0.2.3 release tag to the repo to make sure setuptools_scm uses that as the baseline when generating new dev tags.
On my local machine, setuptools_scm recognized the tag and versioned subsequent commits as follows: