Do not fail metadata generation when git is unavailable#94
Open
plusky wants to merge 1 commit into
Open
Conversation
get_git_commit_id() shells out to `git rev-parse HEAD` to append a commit id to the version. When building from a released source tarball there is no git binary and no repository, so subprocess raises FileNotFoundError, which the handler does not catch -- aborting metadata generation (and thus the whole build). Catch FileNotFoundError alongside CalledProcessError so the clean release version from depyf/VERSION.txt is used instead.
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
1 participant
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.
When building depyf from a released source tarball (e.g. downstream Linux distribution packaging), there is no
gitbinary or repository available.get_git_commit_id()runsgit rev-parse HEADviasubprocess.check_output, which raisesFileNotFoundErrorwhen git is not installed. Theexceptclause only catchessubprocess.CalledProcessError, so the uncaughtFileNotFoundErrorpropagates and aborts metadata generation, breaking the whole build.This adds
FileNotFoundErrorto the caught exceptions soget_git_commit_id()returnsNoneandget_version()falls back to the clean release version fromdepyf/VERSION.txt, exactly as it already does when git exits non-zero.No behavior change when git is present.