Better error messages for cloning failures #284
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
andruwm
reviewed
Jan 6, 2025
clone/clone.go
Outdated
| func Clone(ctx context.Context, input Input) (Output, error) { | ||
| cloneIntoDir := path.Join(input.WorkDir, "cloned") | ||
| if _, err := os.Stat(cloneIntoDir); err == nil { | ||
| // already cloned | ||
| return Output{Success: true, ClonedIntoDir: cloneIntoDir}, nil | ||
| } | ||
|
|
||
| cmd := exec.CommandContext(ctx, "git", "clone", input.GitURL, cloneIntoDir) | ||
| cmd := exec.CommandContext(ctx, "git", "clone", "--quiet", input.GitURL, cloneIntoDir) |
There was a problem hiding this comment.
What's the purpose of the --quiet addition?
There was a problem hiding this comment.
Ah I thought it was worth having more focused output on error but it does seem like in most error cases it's not too much output and we can let the user look over the full (non quiet) log.
For example the non-quiet output for the whitespace issues is:
2025/01/06 10:20:18 exit status 128:
Cloning into '/Users/taylor.sutton/go/src/github.com/Clever/microplane/mp/catapult /clone/cloned'...
fatal: remote error:
Clever/catapult is not a valid repository name
Visit https://support.github.com/ for help
and the quiet output just removes one line
2025/01/06 10:20:18 exit status 128:
fatal: remote error:
Clever/catapult is not a valid repository name
Visit https://support.github.com/ for help
So I'll remove the quiet.
taylor-sutton
force-pushed
the
INFRANG-6515-error-messages
branch
from
65145f2 to
a1b3ae7
Compare
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.
JIRA
https://clever.atlassian.net/browse/INFRANG-6515 (Internal Link)
Overview
When cloning fails, show the actual error output from
gitin the clone status.Testing
Tested by using an init from file with a repo that doesn't exist and one with an invalid name (trailing space as per Jira ticket). Beforehand, the error message is simply
exit status 128. Afterwords, it contains the actual git error.