Add better version reporting.

cmd/version.go

@@ -6,36 +6,69 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	version string
-	commit  string
-	date    string
-	output  string
-)
-
 var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print version info and exit",
 	Run: func(cmd *cobra.Command, args []string) {
-		if cmd.Flag("commit").Value.String() == "true" {
+		PrintVersionInfo()
-			output = commit
-			if date != "" {
-				output += " built on " + date
-			}
-			fmt.Println(output)
-		} else {
-			fmt.Printf("%s-%s\n", version, commit)
-		}
 	},
 }
 
 func init() {
-	versionCmd.Flags().Bool("commit", false, "show the version commit")
 	rootCmd.AddCommand(versionCmd)
 }
 
-func SetVersionInfo(buildVersion string, buildCommit string, buildDate string) {
+// GitCommit stores the latest Git commit hash.
-	version = buildVersion
+// Set via -ldflags "-X main.GitCommit=$(git rev-parse HEAD)"
-	commit = buildCommit
+var GitCommit string
-	date = buildDate
+
+// BuildTime stores the build timestamp in UTC.
+// Set via -ldflags "-X main.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+var BuildTime string
+
+// Version indicates the version of the binary, such as a release number or semantic version.
+// Set via -ldflags "-X main.Version=v1.0.0"
+var Version string
+
+// GitBranch holds the name of the Git branch from which the build was created.
+// Set via -ldflags "-X main.GitBranch=$(git rev-parse --abbrev-ref HEAD)"
+var GitBranch string
+
+// GitTag represents the most recent Git tag at build time, if any.
+// Set via -ldflags "-X main.GitTag=$(git describe --tags --abbrev=0)"
+var GitTag string
+
+// GitState indicates whether the working directory was "clean" or "dirty" (i.e., with uncommitted changes).
+// Set via -ldflags "-X main.GitState=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)"
+var GitState string
+
+// BuildHost stores the hostname of the machine where the binary was built.
+// Set via -ldflags "-X main.BuildHost=$(hostname)"
+var BuildHost string
+
+// GoVersion captures the Go version used to build the binary.
+// Typically, this can be obtained automatically with runtime.Version(), but you can set it manually.
+// Set via -ldflags "-X main.GoVersion=$(go version | awk '{print $3}')"
+var GoVersion string
+
+// BuildUser is the username of the person or system that initiated the build process.
+// Set via -ldflags "-X main.BuildUser=$(whoami)"
+var BuildUser string
+
+// PrintVersionInfo outputs all versioning information for troubleshooting or version checks.
+func PrintVersionInfo() {
+	fmt.Printf("Version: %s\n", Version)
+	fmt.Printf("Git Commit: %s\n", GitCommit)
+	fmt.Printf("Build Time: %s\n", BuildTime)
+	fmt.Printf("Git Branch: %s\n", GitBranch)
+	fmt.Printf("Git Tag: %s\n", GitTag)
+	fmt.Printf("Git State: %s\n", GitState)
+	fmt.Printf("Build Host: %s\n", BuildHost)
+	fmt.Printf("Go Version: %s\n", GoVersion)
+	fmt.Printf("Build User: %s\n", BuildUser)
+}
+
+func VersionInfo() string {
+	return fmt.Sprintf("Version: %s, Git Commit: %s, Build Time: %s, Git Branch: %s, Git Tag: %s, Git State: %s, Build Host: %s, Go Version: %s, Build User: %s",
+		Version, GitCommit, BuildTime, GitBranch, GitTag, GitState, BuildHost, GoVersion, BuildUser)
 }

main.go

@@ -4,13 +4,6 @@ import (
 	"github.com/OpenCHAMI/magellan/cmd"
 )
 
-var (
-	version string
-	commit  string
-	date    string
-)
-
 func main() {
-	cmd.SetVersionInfo(version, commit, date)
 	cmd.Execute()
 }