feat(git): log parsed gitURL and warn if local #345
Merged
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
mafredri
reviewed
Sep 12, 2024
mafredri
approved these changes
Sep 12, 2024
| @@ -47,11 +46,12 @@ type CloneRepoOptions struct { | |||
| // be cloned again. | |||
| // | |||
| // The bool returned states whether the repository was cloned or not. | |||
| func CloneRepo(ctx context.Context, opts CloneRepoOptions) (bool, error) { | |||
| func CloneRepo(ctx context.Context, logf func(string, ...any), opts CloneRepoOptions) (bool, error) { | |||
There was a problem hiding this comment.
I think this could be optional as part of options, but not a blocker.
There was a problem hiding this comment.
I don't think it is optional! If it's not provided, we'll try to log and panic.
There was a problem hiding this comment.
Oh, it would be via != nil check or assigning a noop function.
| return func(hostname string, remote net.Addr, key gossh.PublicKey) error { | ||
| var sb strings.Builder | ||
| _ = knownhosts.WriteKnownHost(&sb, hostname, remote, key) | ||
| // skeema/knownhosts uses a fake public key to determine the host key | ||
| // algorithms. Ignore this one. | ||
| if s := sb.String(); !strings.Contains(s, "fake-public-key ZmFrZSBwdWJsaWMga2V5") { | ||
| logger(log.LevelInfo, "#1: 🔑 Got host key: %s", strings.TrimSpace(s)) | ||
| logger("🔑 Got host key: %s", strings.TrimSpace(s)) |
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.
Part of #281
If we go about fetching changes from a remote repo, we're going to want to log some more information about what's going on.
I also took this opportunity to log some more information about the git URL we parse.
Specifically, if a user passes a git URL in the form of
OrgName/RepoNameour library for parsing git URLs will interpret that as a local URL (file://).go-gitwill fall back to thegitexecutable in this case, which is likely to fail ifgitis not present. I'm choosing to log a warn but not block in case someone decides to make their own envbuilder image withgitinstalled.