Merge pull request #17 from liquidweb/version-cmd

add 'version' command

Author: sgsullivan

.goreleaser.yml

@@ -11,6 +11,7 @@ builds:
     - windows
     - linux
     - darwin
+  ldflags: -X github.com/liquidweb/liquidweb-cli/cmd.Version={{ .Env.VERSION }}  -X github.com/liquidweb/liquidweb-cli/cmd.BuildTime={{ .Env.BUILDTIME }}  -X github.com/liquidweb/liquidweb-cli/cmd.GitCommit={{ .Env.GITCOMMIT }}
 archives:
 - replacements:
     darwin: Darwin

Makefile

@@ -1,41 +1,21 @@
 SHELL=/bin/bash
 
-GO_LINKER_SYMBOL := "main.version"
-
 default:
 	$(MAKE) install
 
-%:
-    @:
-
-args = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
-
-all: build
-
 clean:
 	rm -rf _exe/
 
 static:
-	CGO_ENABLED=0 go build -x -ldflags '-w -extldflags "-static"' -o _exe/liquidweb-cli github.com/liquidweb/liquidweb-cli
+	scripts/build/static
 
 build:
-	go build -ldflags="-s -w" -o _exe/liquidweb-cli github.com/liquidweb/liquidweb-cli
+	scripts/build/dynamic
 
 install:
-	go install
-	@echo ""
-	@echo "liquidweb-cli has been installed, and it should now be in your PATH."
-	@echo ""
-	@echo "Executables are installed in the directory named by the GOBIN environment"
-	@echo "variable, which defaults to GOPATH/bin or HOME/go/bin if the GOPATH"
-	@echo "environment variable is not set. Executables in GOROOT"
-	@echo "are installed in GOROOT/bin or GOTOOLDIR instead of GOBIN."
-	@echo ""
-
-run:
-	go run main.go $(call args,)
+	scripts/build/install
 
 release-build:
-	goreleaser --snapshot --skip-publish --rm-dist
+	scripts/build/release-build
 
-.PHONY: clean static all build run
+.PHONY: clean static all build

cmd/version.go

@@ -0,0 +1,47 @@
+/*
+Copyright © LiquidWeb
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// default build-time variables; these are overridden via ldflags
+var (
+	Version   = "unknown-version"
+	GitCommit = "unknown-commit"
+	BuildTime = "unknown-buildtime"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "show build information",
+	Long: `Show build information.
+
+This information should be provided with any bug report.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("LiquidWeb CLI Build Details\n\n")
+		fmt.Printf("  Build Time: %s\n", BuildTime)
+		fmt.Printf("  Version: %s\n", Version)
+		fmt.Printf("  Git commit: %s\n\n", GitCommit)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

scripts/build/.variables

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+unset LDFLAGS
+
+GITCOMMIT=$(git rev-parse --short HEAD 2> /dev/null)
+BUILDTIME=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+
+latest_tag=$(git describe --abbrev=0 --tags)
+gitcommit_match_tag=$(git describe --exact-match ${GITCOMMIT} 2> /dev/null)
+
+if [[ "${gitcommit_match_tag}" == "${latest_tag}" ]]; then
+    # building on official tag
+    VERSION=${latest_tag}
+else
+    # -dirty because its a dev build, not on a official tag.
+    VERSION="${latest_tag}-dirty"
+fi
+
+export LDFLAGS="\
+    -w \
+    -X \"github.com/liquidweb/liquidweb-cli/cmd.GitCommit=${GITCOMMIT}\" \
+    -X \"github.com/liquidweb/liquidweb-cli/cmd.BuildTime=${BUILDTIME}\" \
+    -X \"github.com/liquidweb/liquidweb-cli/cmd.Version=${VERSION}\" \
+    ${LDFLAGS:-} \
+"

scripts/build/dynamic

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source scripts/build/.variables
+set -e
+go build -x --ldflags "${LDFLAGS}" -o _exe/liquidweb-cli github.com/liquidweb/liquidweb-cli
+exit 0

scripts/build/install

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+source scripts/build/.variables
+set -e
+go install -x --ldflags "${LDFLAGS}"
+echo ""
+echo "liquidweb-cli has been installed, and it should now be in your PATH."
+echo ""
+echo "Executables are installed in the directory named by the GOBIN environment"
+echo "variable, which defaults to GOPATH/bin or HOME/go/bin if the GOPATH"
+echo "environment variable is not set. Executables in GOROOT"
+echo "are installed in GOROOT/bin or GOTOOLDIR instead of GOBIN."
+echo ""
+exit 0

scripts/build/release-build

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source scripts/build/.variables
+set -e
+VERSION=${VERSION} GITCOMMIT=${GITCOMMIT} BUILDTIME=${BUILDTIME} goreleaser --snapshot --skip-publish --rm-dist
+exit 0

scripts/build/static

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source scripts/build/.variables
+set -e
+CGO_ENABLED=0 go build -x -ldflags '-w -extldflags "-static"' --ldflags "${LDFLAGS}" -o _exe/liquidweb-cli github.com/liquidweb/liquidweb-cli
+exit 0