internal/cmd: add version subcommand (#20)

Author: joelanford

.github/workflows/ci.yml

@@ -21,7 +21,6 @@ jobs:
       run: make lint
 
     - name: Run GoReleaser
-      uses: goreleaser/goreleaser-action@v2
-      with:
-        version: latest
-        args: release --snapshot --rm-dist
+      run: make release
+      env:
+        RELEASE_ARGS: release --rm-dist --snapshot

.github/workflows/release.yml

@@ -18,12 +18,10 @@ jobs:
       with:
         go-version: 1.14
 
-    - name: GoReleaser
-      uses: goreleaser/goreleaser-action@v2
-      with:
-        version: latest
-        args: release --rm-dist
+    - name: Run GoReleaser
+      run: make release
       env:
+        RELEASE_ARGS: release --rm-dist
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Update new version in krew-index

.goreleaser.yml

@@ -7,6 +7,17 @@ builds:
   binary: kubectl-operator
   env:
   - CGO_ENABLED=0
+  asmflags:
+  - all=-trimpath={{ dir .Env.PWD }}
+  gcflags:
+  - all=-trimpath={{ dir .Env.PWD }}
+  ldflags:
+  - -s
+  - -w
+  - -X github.com/operator-framework/kubectl-operator/internal/version.GitVersion={{.Env.GIT_VERSION}}
+  - -X github.com/operator-framework/kubectl-operator/internal/version.GitCommit={{.Env.GIT_COMMIT}}
+  - -X github.com/operator-framework/kubectl-operator/internal/version.GitCommitTime={{.Env.GIT_COMMIT_TIME}}
+  - -X github.com/operator-framework/kubectl-operator/internal/version.GitTreeState={{.Env.GIT_TREE_STATE}}
   goos:
   - linux
   - darwin

Makefile

@@ -1,20 +1,43 @@
-.PHONY: all build gen-demo lint
-all: build
+SHELL:=/bin/bash
 
+export GIT_VERSION = $(shell git describe --tags --always)
+export GIT_COMMIT = $(shell git rev-parse HEAD)
+export GIT_COMMIT_TIME = $(shell TZ=UTC git show -s --format=%cd --date=format-local:%Y-%m-%dT%TZ)
+export GIT_TREE_STATE = $(shell sh -c '(test -n "$(shell git status -s)" && echo "dirty") || echo "clean"')
+
+REPO = $(shell go list -m)
+GO_BUILD_ARGS = \
+  -gcflags "all=-trimpath=$(shell dirname $(shell pwd))" \
+  -asmflags "all=-trimpath=$(shell dirname $(shell pwd))" \
+  -ldflags " \
+    -s \
+    -w \
+    -X '$(REPO)/internal/version.GitVersion=$(GIT_VERSION)' \
+    -X '$(REPO)/internal/version.GitCommit=$(GIT_COMMIT)' \
+    -X '$(REPO)/internal/version.GitCommitTime=$(GIT_COMMIT_TIME)' \
+    -X '$(REPO)/internal/version.GitTreeState=$(GIT_TREE_STATE)' \
+  " \
+
+.PHONY: all
+all: install
+
+.PHONY: build
 build:
-	go build -o bin/kubectl-operator
+	go build $(GO_BUILD_ARGS) -o bin/kubectl-operator
 
+.PHONY: install
 install: build
 	install bin/kubectl-operator $(shell go env GOPATH)/bin
 
+.PHONY: gen-demo
 gen-demo:
 	./assets/demo/gen-demo.sh
 
-GOLANGCI_LINT_VER = "1.29.0"
+.PHONY: lint
 lint:
-#	scripts/golangci-lint-check.sh
-ifneq (${GOLANGCI_LINT_VER}, "$(shell ./bin/golangci-lint --version 2>/dev/null | cut -b 27-32)")
-	@echo "golangci-lint missing or not version '${GOLANGCI_LINT_VER}', downloading..."
-	curl -sSfL "https://raw.githubusercontent.com/golangci/golangci-lint/v${GOLANGCI_LINT_VER}/install.sh" | sh -s -- -b ./bin "v${GOLANGCI_LINT_VER}"
-endif
-	./bin/golangci-lint --timeout 3m run
+	source ./scripts/fetch.sh; fetch golangci-lint 1.29.0 && ./bin/golangci-lint --timeout 3m run
+
+.PHONY: release
+RELEASE_ARGS?=release --rm-dist --snapshot
+release:
+	source ./scripts/fetch.sh; fetch goreleaser 0.141.0 && ./bin/goreleaser $(RELEASE_ARGS)

go.sum

@@ -40,6 +40,7 @@ operators from the installed catalogs.`,
 		newOperatorUninstallCmd(&cfg),
 		newOperatorListCmd(&cfg),
 		newOperatorListAvailableCmd(&cfg),
+		newVersionCmd(),
 	)
 
 	return cmd

internal/cmd/root.go

@@ -0,0 +1,20 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/operator-framework/kubectl-operator/internal/version"
+)
+
+func newVersionCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "version",
+		Short: "Print version information",
+		Run: func(_ *cobra.Command, _ []string) {
+			fmt.Printf("%#v\n", version.Version)
+		},
+	}
+	return cmd
+}

internal/cmd/version.go

@@ -0,0 +1,40 @@
+package version
+
+import (
+	"fmt"
+	"runtime"
+)
+
+var (
+	GitVersion    = "unknown"
+	GitCommit     = "unknown"
+	GitCommitTime = "unknown"
+	GitTreeState  = "unknown"
+	GoVersion     = runtime.Version()
+	Compiler      = runtime.Compiler
+	Platform      = fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH)
+)
+
+type Info struct {
+	GitVersion    string
+	GitCommit     string
+	GitCommitTime string
+	GitTreeState  string
+	GoVersion     string
+	Compiler      string
+	Platform      string
+}
+
+var Version Info
+
+func init() {
+	Version = Info{
+		GitVersion:    GitVersion,
+		GitCommit:     GitCommit,
+		GitCommitTime: GitCommitTime,
+		GitTreeState:  GitTreeState,
+		GoVersion:     GoVersion,
+		Compiler:      Compiler,
+		Platform:      Platform,
+	}
+}

internal/version/version.go

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+ROOT="$( git rev-parse --show-toplevel )"
+
+fetch() {
+  local tool=$1; shift
+  local ver=$1; shift
+
+  local ver_cmd=""
+  local tool_fetch_cmd=""
+  case "$tool" in
+    "golangci-lint")
+      ver_cmd="${ROOT}/bin/golangci-lint --version 2>/dev/null | cut -d\" \" -f4"
+      fetch_cmd="curl -sSfL \"https://raw.githubusercontent.com/golangci/golangci-lint/v${ver}/install.sh\" | sh -s -- -b \"${ROOT}/bin\" \"v${ver}\""
+      ;;
+    "goreleaser")
+      ver_cmd="${ROOT}/bin/goreleaser --version 2>/dev/null | grep version | cut -d' ' -f3"
+      fetch_cmd="curl -sSfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh -s -- -b \"${ROOT}/bin\" -d \"v${ver}\""
+      ;;
+    *)
+      echo "unknown tool $tool"
+      return 1
+      ;;
+  esac
+
+  if [[ "${ver}" != "$(eval ${ver_cmd})" ]]; then
+    echo "${tool} missing or not version '${ver}', downloading..."
+    eval ${fetch_cmd}
+  fi
+}