Merge pull request #37 from go-ksplit/laverya/version-command

add version command

Makefile

@@ -3,6 +3,34 @@
 SHELL := /bin/bash -o pipefail
 SRC = $(shell find . -name "*.go")
 
+VERSION ?=`git describe --tags`
+DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"`
+VERSION_PACKAGE = github.com/go-ksplit/ksplit/pkg/version
+GIT_TREE = $(shell git rev-parse --is-inside-work-tree 2>/dev/null)
+ifneq "$(GIT_TREE)" ""
+define GIT_UPDATE_INDEX_CMD
+git update-index --assume-unchanged
+endef
+define GIT_SHA
+`git rev-parse HEAD`
+endef
+else
+define GIT_UPDATE_INDEX_CMD
+echo "Not a git repo, skipping git update-index"
+endef
+define GIT_SHA
+""
+endef
+endif
+
+define LDFLAGS
+-ldflags "\
+	-X ${VERSION_PACKAGE}.version=${VERSION} \
+	-X ${VERSION_PACKAGE}.gitSHA=${GIT_SHA} \
+	-X ${VERSION_PACKAGE}.buildTime=${DATE} \
+"
+endef
+
 test:
 	GO111MODULE=on go test --race -v ./...
 
@@ -16,4 +44,7 @@ build: bin/ksplit
 
 bin/ksplit: $(SRC) go.mod go.sum
 	@mkdir -p bin/
-	go build -o bin/ksplit ./ksplit
+	go build \
+		-o bin/ksplit \
+		${LDFLAGS} \
+	    ./ksplit

ksplit/cmd/allsplit.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/go-ksplit/ksplit/pkg"
+	"github.com/go-ksplit/ksplit/pkg/splitter"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -23,7 +23,7 @@ func AllSplitCmd() *cobra.Command {
 				return errors.New("Please supply a directory")
 			}
 
-			err := pkg.MaybeSplitMultidocYamlFs(args[0])
+			err := splitter.MaybeSplitMultidocYamlFs(args[0])
 			if err != nil {
 				return errors.Wrap(err, "allsplit cmd")
 			}

ksplit/cmd/crdsplit.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/go-ksplit/ksplit/pkg"
+	"github.com/go-ksplit/ksplit/pkg/splitter"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -23,7 +23,7 @@ func CrdSplitCmd() *cobra.Command {
 				return errors.New("Please supply a directory")
 			}
 
-			err := pkg.MaybeSplitCRDsFs(args[0])
+			err := splitter.MaybeSplitCRDsFs(args[0])
 			if err != nil {
 				return errors.Wrap(err, "crdsplit cmd")
 			}

ksplit/cmd/version.go

@@ -0,0 +1,36 @@
+package cmd
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/go-ksplit/ksplit/pkg/version"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+func Version() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:           "version",
+		Short:         "ksplit version information",
+		Long:          `Prints the current version of ksplit`,
+		SilenceErrors: true,
+		PreRun: func(cmd *cobra.Command, args []string) {
+			viper.BindPFlags(cmd.Flags())
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			v := viper.GetViper()
+			if v.GetBool("verbose") {
+				fmt.Printf("ksplit %s built at %s with sha %s\n", version.Version(), version.BuildTime().Format(time.RFC3339), version.GitSHA())
+			} else {
+				fmt.Printf("ksplit %s\n", version.Version())
+			}
+
+			return nil
+		},
+	}
+
+	cmd.Flags().Bool("verbose", false, "when set, also print build info")
+
+	return cmd
+}

ksplit/main.go

@@ -24,6 +24,7 @@ func RootCmd() *cobra.Command {
 
 	cmd.AddCommand(cmd2.CrdSplitCmd())
 	cmd.AddCommand(cmd2.AllSplitCmd())
+	cmd.AddCommand(cmd2.Version())
 
 	_ = viper.BindPFlags(cmd.Flags())
 	_ = viper.BindPFlags(cmd.PersistentFlags())

pkg/ksplit.go → pkg/splitter/ksplit.go

@@ -1,4 +1,4 @@
-package pkg
+package splitter
 
 import (
 	"bytes"

pkg/ksplit_test.go → pkg/splitter/ksplit_test.go

@@ -1,4 +1,4 @@
-package pkg
+package splitter
 
 import (
 	"os"

pkg/version/build.go

@@ -0,0 +1,7 @@
+package version
+
+// NOTE: these variables are injected at build time
+
+var (
+	version, gitSHA, buildTime string
+)

pkg/version/version.go

@@ -0,0 +1,64 @@
+package version
+
+import (
+	"time"
+)
+
+var (
+	build    Build
+	hasBuilt = false
+)
+
+// Build holds details about this build of the Ship binary
+type Build struct {
+	Version      string    `json:"version,omitempty"`
+	GitSHA       string    `json:"git,omitempty"`
+	BuildTime    time.Time `json:"buildTime,omitempty"`
+	TimeFallback string    `json:"buildTimeFallback,omitempty"`
+}
+
+// Init sets up the version info from build args
+func Init() {
+	build.Version = version
+	if len(gitSHA) >= 7 {
+		build.GitSHA = gitSHA[:7]
+	}
+	var err error
+	build.BuildTime, err = time.Parse(time.RFC3339, buildTime)
+	if err != nil {
+		build.TimeFallback = buildTime
+	}
+	hasBuilt = true
+}
+
+// GetBuild gets the build
+func GetBuild() Build {
+	if !hasBuilt {
+		Init()
+	}
+	return build
+}
+
+// Version gets the version
+func Version() string {
+	if !hasBuilt {
+		Init()
+	}
+	return build.Version
+}
+
+// GitSHA gets the gitsha
+func GitSHA() string {
+	if !hasBuilt {
+		Init()
+	}
+	return build.GitSHA
+}
+
+// BuildTime gets the build time
+func BuildTime() time.Time {
+	if !hasBuilt {
+		Init()
+	}
+	return build.BuildTime
+}