ci: rename develop release channel from dev to rc
#22
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
This project employs the use of the [setuptools scm](https://setuptools-scm.readthedocs.io/en/latest/) plugin during builds to extract package versions from git. Unfortunately, this plugin forbids tagging dev releases. See this [comment](pypa/setuptools_scm#213 (comment)) for more details. This causes issues when building the project outside the CI where `setuptools_scm` keeps failing when the last tag is a "dev" tag. And although `setuptools_scm` provides a mechanism to [override the version](https://setuptools-scm.readthedocs.io/en/latest/overrides/#pretend-versions) at build, this doesn't work when building with `tox`. This is highly inconvenient as `tox` is handy for running tests and other workflows such as linting and building docs. From the problem description above, the solution is to change the tagging of the dev releases to something else. I pick *rc*(release candidate), which coincidentally I believe is more appropriate as changes on the develop branch constitute contents of the next major release.
saladgg
approved these changes
Mar 21, 2024
|
🎉 This PR is included in version 1.1.0-rc.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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.
This project employs the use of the setuptools scm plugin during builds to extract package versions from git. Unfortunately, this plugin forbids tagging dev releases. See this comment for more details.
This causes issues when building the project outside the CI where
setuptools_scmkeeps failing when the last tag is a "dev" tag. And althoughsetuptools_scmprovides a mechanism to override the version at build, this doesn't work when building withtox. This is highly inconvenient astoxis handy for running tests and other workflows such as linting and building docs.From the problem description above, the solution is to change the tagging of the dev releases to something else. I pick rc(release candidate), which coincidentally I believe is more appropriate as changes on the develop branch constitute contents of the next major release.