Merge pull request #26 from sarus-suite/fc-version-metadata-injection

Releases now print correct metadata for version, commit, and build data

Author: fcruzcscs

.github/workflows/release-opensuse156.yml

@@ -59,10 +59,13 @@ jobs:
           GOFLAGS: "-buildvcs=false"
           GO_LDFLAGS: "-linkmode external"
           CGO_LDFLAGS: "-g -O2"
+          VERSION_LDFLAGS: "-X parallax/common.Version=${{ github.ref_name }} \
+                            -X parallax/common.Commit=${{ github.sha }} \
+                            -X parallax/common.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)"
         run: |
           mkdir -p dist
           go build -v -x \
-              -ldflags "-X 'github.com/sarus-suite/parallax/version.Version=${{ github.ref_name }}'" \
+              -ldflags "$GO_LDFLAGS $VERSION_LDFLAGS" \
               -o dist/parallax-${{ github.ref_name }}-opensuse-15.6-${{ matrix.arch }} \
               .
 

.github/workflows/release.yml

@@ -59,10 +59,13 @@ jobs:
           GOFLAGS: "-buildvcs=false"
           GO_LDFLAGS: "-linkmode external"
           CGO_LDFLAGS: "-g -O2"
+          VERSION_LDFLAGS: "-X parallax/common.Version=${{ github.ref_name }} \
+                            -X parallax/common.Commit=${{ github.sha }} \
+                            -X parallax/common.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)"
         run: |
           mkdir -p dist
           go build -v -x \
-              -ldflags "-X 'github.com/sarus-suite/parallax/version.Version=${{ github.ref_name }}'" \
+              -ldflags "$GO_LDFLAGS $VERSION_LDFLAGS" \
               -o dist/parallax-${{ github.ref_name }}-opensuse-15.5-${{ matrix.arch }} \
               .
 

.github/workflows/unified-vs-test.yml

@@ -37,6 +37,7 @@ jobs:
           -w "$PWD" \
           --env TMP_DIR="$TMP_DIR" \
           --env GITHUB_REF_NAME="$GITHUB_REF_NAME" \
+          --env GITHUB_SHA="$GITHUB_SHA" \
           ghcr.io/sarus-suite/parallax/ci-runner:latest \
           bash -euxc '
             mkdir -p $TMP_DIR/dist
@@ -57,8 +58,13 @@ jobs:
             export CGO_LDFLAGS="-g -O2"
             export GOARCH="$HOST_ARCH"
             export GOOS=linux
+            export VERSION_LDFLAGS="-X parallax/common.Version=${GITHUB_REF_NAME} \
+                                  -X parallax/common.Commit=${GITHUB_SHA} \
+                                  -X parallax/common.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+
 
             go build -v \
+              -ldflags "$GO_LDFLAGS $VERSION_LDFLAGS" \
               -o "$TMP_DIR/dist/$OUT" \
               .
            echo Built binary: "$TMP_DIR/dist/$OUT"

common/cli.go

@@ -10,9 +10,6 @@ import (
 	"github.com/mattn/go-shellwords"
 )
 
-// TODO: auto gen version field
-const Version = "1.0.0"
-
 func usage_banner() {
     out := flag.CommandLine.Output()
 
@@ -115,7 +112,7 @@ func ParseAndValidateFlags(fs *flag.FlagSet, args []string) (*CLI, error) {
 
 	// Fast version exit
 	if *versionF {
-		fmt.Fprintf(os.Stdout, "Parallax version %s\n", Version)
+		VersionPrint()
 		os.Exit(0)
 	}
 

common/version.go

@@ -0,0 +1,22 @@
+package common
+
+import (
+    "fmt"
+)
+
+var (
+    // These to get overriden at build time via flags
+	Version = "unversioned"
+	Commit = "unknown"
+	BuildDate = "unknown"
+)
+
+func VersionPrint() {
+    fmt.Printf("Parallax version: %s\n", Version)
+	if Commit != "" && Commit != "unknown" {
+        fmt.Printf("Commit: %s\n", Commit)
+	}
+	if BuildDate != "" && BuildDate != "unknown" {
+        fmt.Printf("Build date: %s\n", BuildDate)
+	}
+}