add BuildDate to version

Author: kindermax

.goreleaser.yml

@@ -23,7 +23,7 @@ builds:
     flags:
       - -mod=readonly
     ldflags:
-      - -s -w -X main.Version={{.Version}}
+      - -s -w -X main.Version={{.Version}} -X main.BuildDate={{.Date}}
   - id: darwin-arm64
     main: ./cmd/lets
     goos:
@@ -38,7 +38,7 @@ builds:
     flags:
       - -mod=readonly
     ldflags:
-      - -s -w -X main.Version={{.Version}}
+      - -s -w -X main.Version={{.Version}} -X main.BuildDate={{.Date}}
   - id: linux-amd64
     main: ./cmd/lets
     goos:
@@ -51,7 +51,7 @@ builds:
     flags:
       - -mod=readonly
     ldflags:
-      - -s -w -X main.Version={{.Version}}
+      - -s -w -X main.Version={{.Version}} -X main.BuildDate={{.Date}}
 
 archives:
 - formats: [tar.gz]

cmd/lets/main.go

@@ -21,6 +21,7 @@ import (
 )
 
 var Version = "0.0.0-dev"
+var BuildDate = ""
 
 func main() {
 	ctx := getContext()
@@ -29,7 +30,7 @@ func main() {
 
 	logging.InitLogging(os.Stdout, os.Stderr)
 
-	rootCmd := cmd.CreateRootCommand(Version)
+	rootCmd := cmd.CreateRootCommand(Version, BuildDate)
 	rootCmd.InitDefaultHelpFlag()
 	rootCmd.InitDefaultVersionFlag()
 	reinitCompletionCmd := cmd.InitCompletionCmd(rootCmd, nil)

internal/cmd/root.go

@@ -80,8 +80,9 @@ func newRootCmd(version string) *cobra.Command {
 }
 
 // CreateRootCommand used to run only root command without config.
-func CreateRootCommand(version string) *cobra.Command {
+func CreateRootCommand(version string, buildDate string) *cobra.Command {
 	rootCmd := newRootCmd(version)
+	rootCmd.Annotations = map[string]string{"buildDate": buildDate}
 
 	initRootFlags(rootCmd)
 
@@ -230,6 +231,10 @@ func PrintRootHelpMessage(cmd *cobra.Command) error {
 }
 
 func PrintVersionMessage(cmd *cobra.Command) error {
-	_, err := fmt.Fprintf(cmd.OutOrStdout(), "lets version %s\n", cmd.Version)
+	msg := fmt.Sprintf("lets version %s", cmd.Version)
+	if buildDate := cmd.Annotations["buildDate"]; buildDate != "" {
+		msg += fmt.Sprintf(" (%s)", buildDate)
+	}
+	_, err := fmt.Fprintln(cmd.OutOrStdout(), msg)
 	return err
 }

internal/cmd/root_test.go

@@ -11,7 +11,7 @@ import (
 )
 
 func newTestRootCmd(args []string) (rootCmd *cobra.Command) {
-	root := CreateRootCommand("v0.0.0-test")
+	root := CreateRootCommand("v0.0.0-test", "")
 	root.SetArgs(args)
 	InitCompletionCmd(root, nil)
 
@@ -27,7 +27,7 @@ func newTestRootCmdWithConfig(args []string) (rootCmd *cobra.Command, out *bytes
 	cfg.Commands["foo"] = &config.Command{Name: "foo"}
 	cfg.Commands["bar"] = &config.Command{Name: "bar"}
 
-	root := CreateRootCommand("v0.0.0-test")
+	root := CreateRootCommand("v0.0.0-test", "")
 	root.SetArgs(args)
 	root.SetOut(bufOut)
 	root.SetErr(bufOut)
@@ -142,7 +142,7 @@ func TestSelfCmd(t *testing.T) {
 	t.Run("should return exit code 2 for unknown self subcommand", func(t *testing.T) {
 		bufOut := new(bytes.Buffer)
 
-		rootCmd := CreateRootCommand("v0.0.0-test")
+		rootCmd := CreateRootCommand("v0.0.0-test", "")
 		rootCmd.SetArgs([]string{"self", "ls"})
 		rootCmd.SetOut(bufOut)
 		rootCmd.SetErr(bufOut)
@@ -178,7 +178,7 @@ func TestSelfCmd(t *testing.T) {
 	t.Run("should return exit code 2 for unknown self subcommand with no suggestions", func(t *testing.T) {
 		bufOut := new(bytes.Buffer)
 
-		rootCmd := CreateRootCommand("v0.0.0-test")
+		rootCmd := CreateRootCommand("v0.0.0-test", "")
 		rootCmd.SetArgs([]string{"self", "zzzznotacommand"})
 		rootCmd.SetOut(bufOut)
 		rootCmd.SetErr(bufOut)

lets.yaml

@@ -109,7 +109,7 @@ commands:
         PATH2LETSDEV=$LETSOPT_PATH
       fi
 
-      go build -ldflags="-X main.Version=${VERSION:1}-dev" -o "${BIN}" ./cmd/lets && \
+      go build -ldflags="-X main.Version=${VERSION:1}-dev -X main.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)" -o "${BIN}" ./cmd/lets && \
       sudo mv ./${BIN} $PATH2LETSDEV/${BIN} && \
       echo " - binary ${BIN} version $($PATH2LETSDEV/${BIN} --version) successfully installed in ${PATH2LETSDEV}"
 
@@ -122,7 +122,7 @@ commands:
       BIN=${LETSOPT_BIN:-lets}
       
       go build \
-        -ldflags="-X main.Version=${VERSION:1}-dev" \
+        -ldflags="-X main.Version=${VERSION:1}-dev -X main.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
         -o ${BIN} ./cmd/lets
       
       success=$?

tests/config_version.bats

@@ -6,7 +6,7 @@ setup() {
   load "${BATS_UTILS_PATH}/bats-support/load.bash"
   load "${BATS_UTILS_PATH}/bats-assert/load.bash"
   # NOTICE to test this functionality properly we building lets with specified version ${TEST_VERSION}
-  go build -ldflags="-X main.Version=${TEST_VERSION}" -o ./tests/config_version/lets cmd/lets/main.go
+  go build -ldflags="-X main.Version=${TEST_VERSION} -X main.BuildDate=2024-01-01T00:00:00Z" -o ./tests/config_version/lets cmd/lets/main.go
   cd ./tests/config_version
 }
 

tests/version.bats

@@ -1,3 +1,8 @@
+load test_helpers
+
+TEST_VERSION=1.2.3
+TEST_BUILD_DATE=2024-01-15T10:30:00Z
+
 setup() {
     load "${BATS_UTILS_PATH}/bats-support/load.bash"
     load "${BATS_UTILS_PATH}/bats-assert/load.bash"
@@ -14,3 +19,11 @@ setup() {
     assert_success
     assert_line --index 0 "lets version 0.0.0-dev"
 }
+
+@test "version: show build date when set via ldflags" {
+    go build -ldflags="-X main.Version=${TEST_VERSION} -X main.BuildDate=${TEST_BUILD_DATE}" -o /tmp/lets-version-test cmd/lets/main.go
+    run /tmp/lets-version-test --version
+    assert_success
+    assert_line --index 0 "lets version ${TEST_VERSION} (${TEST_BUILD_DATE})"
+    rm -f /tmp/lets-version-test
+}