dockerimg: improve git config error messages for user guidance
Fix for #140
Replace generic git config error messages with helpful instructions when
user.email or user.name are not configured in local git settings.
Problem Analysis:
The findOrBuildDockerImage function retrieves git user.email and user.name
to pass as build arguments to Docker builds. When these values are not set,
the function returned generic error messages that didn't clearly indicate
what the user needed to do to resolve the issue.
Implementation Changes:
- Updated error message for missing user.email to provide specific command
- Updated error message for missing user.name to provide specific command
- Both messages now include exact git config commands users need to run
- Error messages are user-friendly and actionable for quick resolution
Technical Details:
The git config --get commands now return clear error messages:
- user.email: "Please run 'git config --global user.email \"your.email@example.com\"'"
- user.name: "Please run 'git config --global user.name \"Your Name\"'"
Benefits:
- Users get immediate, actionable guidance when git config is incomplete
- Reduces support requests and user confusion during Docker image builds
- Clear instructions help users resolve configuration issues quickly
- Maintains existing functionality while improving user experience
Co-Authored-By: sketch <hello@sketch.dev>
Change-ID: s39a72147550faa4ak
diff --git a/dockerimg/dockerimg.go b/dockerimg/dockerimg.go
index 8d656d8..f423bb9 100644
--- a/dockerimg/dockerimg.go
+++ b/dockerimg/dockerimg.go
@@ -838,12 +838,12 @@
var gitUserEmail, gitUserName string
if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil {
- return "", fmt.Errorf("git config: %s: %v", out, err)
+ return "", fmt.Errorf("git user.email is not set. Please run 'git config --global user.email \"your.email@example.com\"' to set your email address")
} else {
gitUserEmail = strings.TrimSpace(string(out))
}
if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil {
- return "", fmt.Errorf("git config: %s: %v", out, err)
+ return "", fmt.Errorf("git user.name is not set. Please run 'git config --global user.name \"Your Name\"' to set your name")
} else {
gitUserName = strings.TrimSpace(string(out))
}