feat: make version info generating automatically

Author: moooofly

Makefile

@@ -1,23 +1,43 @@
+GOPATH ?= $(shell go env GOPATH)
+
+# Ensure GOPATH is set before running build process.
+ifeq "$(GOPATH)" ""
+  $(error Please set the environment variable GOPATH before running `make`)
+endif
+
+
+GO        := go
+GOBUILD   := CGO_ENABLED=0 $(GO) build $(BUILD_FLAG)
+
+
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.ClientVersion=$(shell cat VERSION)"
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.GoVersion=$(shell go version)"
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.UTCBuildTime=$(shell date -u '+%Y-%m-%d %I:%M:%S')"
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.GitBranch=$(shell git rev-parse --abbrev-ref HEAD)"
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.GitTag=$(shell git describe --tags)"
+LDFLAGS += -X "github.com/moooofly/harbor-go-client/utils.GitHash=$(shell git rev-parse HEAD)"
+
 all: lint build test
 
 build:
-	go build -x ./
+	$(GOBUILD) -ldflags '$(LDFLAGS)' ./
 
 install:
-	go install -x ${SRC}
+	$(GO) install -x ${SRC}
 
 lint:
 	gometalinter --exclude=vendor --disable-all --enable=golint --enable=vet --enable=gofmt --enable=misspell ./...
 	find . -name '*.go' -not -path "./vendor/*" | xargs gofmt -w -s
 
 test:
-	go test ${SRC}
+	$(GO) test ${SRC}
 
 misspell:
 	# misspell - requires that the following be run first:
 	#    go get -u github.com/client9/misspell/cmd/misspell
 	find . -name '*.go' -not -path './vendor/*' -not -path './_repos/*' | xargs misspell -error
 
 clean:
-	go clean -x -i ${SRC}
+	$(GO) clean -x -i ${SRC}
+	rm -rf *.out
 

utils/utils.go

@@ -14,6 +14,16 @@ import (
 	yaml "gopkg.in/yaml.v2"
 )
 
+// These variables are populated via the Go linker.
+var (
+	UTCBuildTime  = "unknown"
+	ClientVersion = "unknown"
+	GoVersion     = "unknown"
+	GitBranch     = "unknown"
+	GitTag        = "unknown"
+	GitHash       = "unknown"
+)
+
 var errMalCookies = errors.New("get malformed cookies")
 var errCookiesNotAvailable = errors.New("target cookies are not available")
 
@@ -26,7 +36,6 @@ var Request = gorequest.New().TLSClientConfig(&tls.Config{InsecureSkipVerify: tr
 
 var configfile = "conf/config.yaml"
 var secretfile = "conf/.cookie.yaml"
-var versionfile = "./VERSION"
 
 // Beegocookie is for beegosessionID storage
 type Beegocookie struct {

utils/version.go

@@ -1,17 +1,13 @@
 package utils
 
 import (
-	"bufio"
 	"fmt"
-	"os"
-	"runtime"
-	"strings"
 )
 
 func init() {
 	Parser.AddCommand("version",
 		"Show version info.",
-		"Format: <client-version> (<golang-runtime-version> on <GOOS>/<GOARCH>; <Compiler>)",
+		"Show version infos as \"| Type | Value |\"",
 		&verinfo)
 }
 
@@ -25,27 +21,15 @@ func (x *verInfo) Execute(args []string) error {
 	return nil
 }
 
-func version() string {
-
-	f, err := os.Open(versionfile)
-	if err != nil {
-		fmt.Println("error:", err)
-		return ""
-	}
-	defer f.Close()
-
-	reader := bufio.NewReader(f)
-	v, err := reader.ReadString('\n')
-	if err != nil {
-		fmt.Println("error:", err)
-		return ""
-	}
-
-	return fmt.Sprintf("%s (%s on %s/%s; %s)",
-		strings.Trim(v, "\n"), runtime.Version(), runtime.GOOS, runtime.GOARCH, runtime.Compiler)
-}
-
 // PrintVersion print version info.
 func PrintVersion() {
-	fmt.Println(version())
+	PrintLogo()
+	fmt.Println("+----------------------+------------------------------------------+")
+	fmt.Printf("| % -20s | % -40s |\n", "Client Version", ClientVersion)
+	fmt.Printf("| % -20s | % -40s |\n", "Go Version", GoVersion)
+	fmt.Printf("| % -20s | % -40s |\n", "UTC Build Time", UTCBuildTime)
+	fmt.Printf("| % -20s | % -40s |\n", "Git Branch", GitBranch)
+	fmt.Printf("| % -20s | % -40s |\n", "Git Tag", GitTag)
+	fmt.Printf("| % -20s | % -40s |\n", "Git Hash", GitHash)
+	fmt.Println("+----------------------+------------------------------------------+")
 }