Produce better error messages for non-binary mix git deps refspecs. #13088
Conversation
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
When using git dependencies, a branch/ref/tag specifier
is passed verbatim to `System.cmd/3`. This can lead to
intimidating error messages when they are not provided
as a binary (for instance, an atom like `tag: :stable`):
```
** (ArgumentError) all arguments for System.cmd/3 must be binaries
(elixir 1.15.6) lib/system.ex:1083: System.cmd/3
(mix 1.15.6) lib/mix/scm/git.ex:287: Mix.SCM.Git.git!/2
(mix 1.15.6) lib/mix/scm/git.ex:136: Mix.SCM.Git.checkout/2
(elixir 1.15.6) lib/file.ex:1624: File.cd!/2
(mix 1.15.6) lib/mix/dep/fetcher.ex:64: Mix.Dep.Fetcher.do_fetch/3
(mix 1.15.6) lib/mix/dep/converger.ex:229: Mix.Dep.Converger.all/8
(mix 1.15.6) lib/mix/dep/converger.ex:162: Mix.Dep.Converger.init_all/8
(mix 1.15.6) lib/mix/dep/converger.ex:110: Mix.Dep.Converger.all/4
```
This PR adds a check during git opts verification time to provide
better feedback.
christhekeele
force-pushed
the
better-errors-for-mix-git-dep-nonstring-refspecs
branch
3 times, most recently
from
224d4a9 to
f1f7c68
Compare
whatyouhide
reviewed
Nov 9, 2023
|
💚 💙 💜 💛 ❤️ |
josevalim
pushed a commit
that referenced
this pull request
Nov 11, 2023
…13088) When using git dependencies, a branch/ref/tag specifier is passed verbatim to `System.cmd/3`. This can lead to intimidating error messages when they are not provided as a binary (for instance, an atom like `tag: :stable`): ``` ** (ArgumentError) all arguments for System.cmd/3 must be binaries (elixir 1.15.6) lib/system.ex:1083: System.cmd/3 (mix 1.15.6) lib/mix/scm/git.ex:287: Mix.SCM.Git.git!/2 ``` This PR adds a check during git opts verification time to provide better feedback.
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.
When using git dependencies, a branch/ref/tag specifier is passed verbatim to
System.cmd/3. This can lead to intimidating error messages when they are not provided as a binary (for instance, an atom liketag: :stable):This PR adds a check during git opts verification time to provide better feedback, earlier.