pyproject.toml: use setuptools_scm to determine version number #44
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 means we no longer have to update the version number manually when creating a new release because just setting a tag suffices. It does however also add some complexity and magic to the project, like incorrect version numbers when the git history is not complete (hence why we now clone the whole history in the build job) and all files included in the git repository now being shipped in the source distribution (while previously only files mentioned in the MANIFEST.in were included). The beneftis when it comes to automating the release process do however outweight the drawbacks of added compexity. We use `local_scheme = "no-local-version"` to prevent random files in the project directory from causing "+dirty" version numbers. Thus use setuptools_scm to determine the version number from git tags. Signed-off-by: Leonard Göhrs <[email protected]>
This was referenced Apr 23, 2024
jluebbe
approved these changes
Apr 24, 2024
SmithChart
approved these changes
Apr 24, 2024
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 means we no longer have to update the version number manually when creating a new release because just setting a tag suffices.
It does however also add some complexity and magic to the project, like incorrect version numbers when the git history is not complete (hence why we now clone the whole history in the build job) and all files included in the git repository now being shipped in the source distribution (while previously only files mentioned in the
MANIFEST.inwere included).The beneftis when it comes to automating the release process do however outweight the drawbacks of added compexity.
We use
local_scheme = "no-local-version"to prevent random files in the project directory from causing+dirtyversion numbers.Thus use
setuptools_scmto determine the version number from git tags.