feat(sources): generate .git_archival.txt for setuptools-scm builds#962
Open
LalatenduMohanty wants to merge 1 commit intopython-wheel-build:mainfrom
Open
Conversation
LalatenduMohanty
force-pushed
the
961_git-archival-for-setuptools-scm
branch
2 times, most recently
from
779259f to
87d777b
Compare
dhellmann
reviewed
Mar 17, 2026
LalatenduMohanty
force-pushed
the
961_git-archival-for-setuptools-scm
branch
3 times, most recently
from
4efaad6 to
545b0a5
Compare
Packages using setuptools-scm fail when built from source archives without .git metadata. Add ensure_git_archival() to synthesize a .git_archival.txt with the resolved version, which setuptools-scm reads before PKG-INFO in its fallback chain. The archival file is only written in default_build_sdist when no .git directory is present, mirroring the guard used elsewhere. Closes: python-wheel-build#961 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
LalatenduMohanty
force-pushed
the
961_git-archival-for-setuptools-scm
branch
from
545b0a5 to
8287e3c
Compare
tiran
reviewed
Mar 20, 2026
Comment on lines
+781
to
+786
| _GIT_ARCHIVAL_CONTENT = """\ | ||
| node: {node} | ||
| node-date: 1970-01-01T00:00:00+00:00 | ||
| describe-name: {version}-0-g{node} | ||
| """ | ||
|
|
Collaborator
There was a problem hiding this comment.
For non-tags, the git log describe output uses the short commit hash:
$ git log --pretty='format:node: %H%nnode-date: %cI%ndescribe-name: %(describe:tags=true,match=*[0-9]*)%n' -1
node: 5d8d986d96be4575ae4b9fe9675f7eb3623057cb
node-date: 2026-03-19T06:57:11Z
describe-name: 0.77.0-13-g5d8d986For release tags, the describe-name is just the tag name without commit counter and g{shorthash}
$ git checkout refs/tags/0.76.0
$ git log --pretty='format:node: %H%nnode-date: %cI%ndescribe-name: %(describe:tags=true,match=*[0-9]*)%n' -1
node: f4a13d04674c1f8fb3e7a7828c8c3dbd5c297ed9
node-date: 2026-02-25T14:00:08Z
describe-name: 0.76.0
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
3 participants
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.
Packages using setuptools-scm fail when built from source archives without .git metadata. Add ensure_git_archival() to synthesize a .git_archival.txt with the resolved version, which setuptools-scm reads before PKG-INFO in its fallback chain.
Closes: #961