make sure git clone with a tag argument actually downloads a tag #3795
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
Avoids accidentally cloning a branch with the same name as that would take preference for the --branch option of git clone
Use shallow checkouts if .git folder is not required Don't download submodules if we do that again for a potentially other version
Check for return value of get_source_tarball_from_git and use context manager
Can't use refs/tags/xxx for git clone so clone it assuming it is a tag and check afterwards. Fall back to fetching the full history and checking out the tag and submodules manually
boegel
changed the title
|
trying to trigger CI run again... |
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.
The
git clonecommand accept a--branchargument to clone a specific branch.We use that to clone/download as tarball tags as it also accepts tags as the branch-argument.
However in case there is both a branch and a tag with the same name (happened in PyTorch) this will download the branch instead.
As contrary to
git checkoutgit clone --branchdoes not accept neither a commit nor a direct tag reference (refs/tags/foo) we cannot reliably clone a tag only. But doing so (especially with--depth 1aka "shallow clone") is considerably faster and saves bandwidth.So the current solution assumes that no branch with the same name as the tag exists and does the clone as before. It then checks, if we indeed cloned a tag
We could error out here, or (as done now) fetch the full history (as in a full clone) and check out the tag and submodules via
refs/tags/foo.--> In almost all cases the download is as fast as possible and it still works in the naughty case where maintainers screwed up and created a branch with the same name as a tag.