Fix setuptools-scm version in container image #575
Merged
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.
Fix container image versioning for tagged releases
Problem:
When building container images from tagged commits,
setuptools-scm
incorrectly appends commit hash and date to the version number. This happens because our build process createsrequirements.txt
, as well as possibly modifyinguv.lock
, causingsetuptools-scm
to detect the repository as "dirty" even though we're building from a clean tagged commit.Solution:
requirements.txt
to.gitignore
to prevent it from being trackedUV_FROZEN=1
environment variable to prevent any modifications to the lock file during buildpyproject.toml
(was missingcoverage[toml]
from Further coverage fixes, now with mocks. #568).This ensures that container images built from tags (e.g.,
v1.2.3
) will have clean version numbers that match the git tag instead of versions with appended hashes (e.g.,1.2.3.dev5+g123abc
).