fix: add version flag (#270)

![CleanShot 2024-08-13 at 11 10
10@2x](https://github.com/user-attachments/assets/e7369805-ceab-4937-98d2-f59f4aafd01e)

Author: jrschumacher

Makefile

@@ -1,55 +1,47 @@
 # We're going to be using this Makefile as a sort of task runner, for all sorts of operations in this project
 
 # first we'll grab the current version from our ENV VAR (added by our CI) - see here: https://github.com/marketplace/actions/version-increment
+BINARY_NAME := otdfctl
 CURR_VERSION := ${SEM_VER}
+COMMIT_SHA := ${GITHUB_SHA}
+BUILD_TIME := $(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
+
+GO_MOD_LINE = $(shell head -n 1 go.mod | cut -c 8-)
+GO_MOD_NAME = $(word 1,$(subst /, ,$(GO_MOD_LINE)))
+APP_CFG = $(GO_MOD_LINE)/pkg/config
+
+GO_BUILD_FLAGS=-ldflags "-X $(APP_CFG).Version=${CURR_VERSION} -X $(APP_CFG).CommitSha=${COMMIT_SHA} -X $(APP_CFG).BuildTime=${BUILD_TIME}"
+GO_BUILD_PREFIX=$(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}
+
+# If commit sha is not available try git
+ifndef COMMIT_SHA
+	COMMIT_SHA := $(shell git rev-parse HEAD)
+endif
+
+# If current version is not available try git
+ifndef CURR_VERSION
+	CURR_VERSION := $(shell git describe --tags --always)
+endif
 
 # Default target executed when no arguments are given to make.
 # NOTE: .PHONY is used to indicate that the target is not a file (e.g. there is no file called 'build-darwin-amd64', instead the .PHONY directive tells make that the proceeding target is a command to be executed, not a file to be generated)
 .PHONY: all
 all: run
 .DEFAULT_GOAL := run
 
-
-
-
-# Binary name: Change this to your actual binary name
-BINARY_NAME=${BIN_NAME}
-
-
 # Target directory for compiled binaries
 TARGET_DIR=target
 
 # Output directory for the zipped artifacts
 OUTPUT_DIR=output
 
-# Targets for building the project for different platforms
-.PHONY: build-darwin-amd64 build-darwin-arm64 build-linux-amd64 build-linux-arm build-linux-arm64 build-windows-amd64 build-windows-arm build-windows-arm64
-build: clean build-darwin-amd64 build-darwin-arm64 build-linux-amd64 build-linux-arm build-linux-arm64 build-windows-amd64 build-windows-arm build-windows-arm64
-
 # Build commands for each platform
-build-darwin-amd64:
-	GOOS=darwin GOARCH=amd64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-darwin-amd64 .
-
-build-darwin-arm64:
-	GOOS=darwin GOARCH=arm64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-darwin-arm64 .
-
-build-linux-amd64:
-	GOOS=linux GOARCH=amd64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-linux-amd64 .
-
-build-linux-arm:
-	GOOS=linux GOARCH=arm go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-linux-arm .
-
-build-linux-arm64:
-	GOOS=linux GOARCH=arm64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-linux-arm64 .
-
-build-windows-amd64:
-	GOOS=windows GOARCH=amd64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-windows-amd64.exe .
+PLATFORMS := darwin-amd64 darwin-arm64 linux-amd64 linux-arm linux-arm64 windows-amd64-.exe windows-arm-.exe windows-arm64-.exe
 
-build-windows-arm:
-	GOOS=windows GOARCH=arm go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-windows-arm.exe .
+build: clean $(addprefix build-,$(PLATFORMS))
 
-build-windows-arm64:
-	GOOS=windows GOARCH=arm64 go build -o $(TARGET_DIR)/$(BINARY_NAME)-${CURR_VERSION}-windows-arm64.exe .
+build-%:
+	GOOS=$(word 1,$(subst -, ,$*)) GOARCH=$(word 2,$(subst -, ,$*)) go build $(GO_BUILD_FLAGS) -o $(GO_BUILD_PREFIX)-$(word 1,$(subst -, ,$*))-$(word 2,$(subst -, ,$*))$(word 3,$(subst -, ,$*))
 
 # Target for running the project (adjust as necessary for your project)
 .PHONY: run

cmd/config.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/opentdf/otdfctl/internal/config"
 	"github.com/opentdf/otdfctl/pkg/cli"
+	"github.com/opentdf/otdfctl/pkg/config"
 	"github.com/opentdf/otdfctl/pkg/man"
 	"github.com/spf13/cobra"
 )

cmd/dev.go

@@ -9,8 +9,8 @@ import (
 	"strings"
 
 	"github.com/evertras/bubble-table/table"
-	"github.com/opentdf/otdfctl/internal/config"
 	"github.com/opentdf/otdfctl/pkg/cli"
+	"github.com/opentdf/otdfctl/pkg/config"
 	"github.com/opentdf/otdfctl/pkg/handlers"
 	"github.com/opentdf/otdfctl/pkg/man"
 	"github.com/opentdf/platform/protocol/go/common"

cmd/execute.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/opentdf/otdfctl/internal/config"
+	"github.com/opentdf/otdfctl/pkg/config"
 	"github.com/spf13/cobra"
 )
 

cmd/root.go

@@ -4,7 +4,10 @@ Copyright © 2023 NAME HERE <EMAIL ADDRESS>
 package cmd
 
 import (
-	"github.com/opentdf/otdfctl/internal/config"
+	"fmt"
+
+	"github.com/opentdf/otdfctl/pkg/cli"
+	"github.com/opentdf/otdfctl/pkg/config"
 	"github.com/opentdf/otdfctl/pkg/man"
 	"github.com/spf13/cobra"
 )
@@ -20,39 +23,55 @@ var (
 
 // RootCmd represents the base command when called without any subcommands.
 var (
-	defaultCmdName = "otdfctl"
-	RootCmd        = &man.Docs.GetDoc("<root>").Command
+	RootCmd = &man.Docs.GetDoc("<root>").Command
 )
 
 func init() {
-	doc := man.Docs.GetDoc("<root>")
-	RootCmd = &doc.Command
+	rootCmd := man.Docs.GetCommand("<root>", man.WithRun(func(cmd *cobra.Command, args []string) {
+		flaghelper := cli.NewFlagHelper(cmd)
+
+		if flaghelper.GetOptionalBool("version") {
+			fmt.Println(config.AppName + " version " + config.Version + " (" + config.BuildTime + ") " + config.CommitSha)
+			return
+		}
+
+		cmd.Help()
+	}))
+
+	RootCmd = &rootCmd.Command
+
+	RootCmd.Flags().Bool(
+		rootCmd.GetDocFlag("version").Name,
+		rootCmd.GetDocFlag("version").DefaultAsBool(),
+		rootCmd.GetDocFlag("version").Description,
+	)
+
 	RootCmd.PersistentFlags().String(
-		doc.GetDocFlag("host").Name,
-		doc.GetDocFlag("host").Default,
-		doc.GetDocFlag("host").Description,
+		rootCmd.GetDocFlag("host").Name,
+		rootCmd.GetDocFlag("host").Default,
+		rootCmd.GetDocFlag("host").Description,
 	)
 	RootCmd.PersistentFlags().Bool(
-		doc.GetDocFlag("tls-no-verify").Name,
-		doc.GetDocFlag("tls-no-verify").DefaultAsBool(),
-		doc.GetDocFlag("tls-no-verify").Description,
+		rootCmd.GetDocFlag("tls-no-verify").Name,
+		rootCmd.GetDocFlag("tls-no-verify").DefaultAsBool(),
+		rootCmd.GetDocFlag("tls-no-verify").Description,
 	)
 	RootCmd.PersistentFlags().String(
-		doc.GetDocFlag("log-level").Name,
-		doc.GetDocFlag("log-level").Default,
-		doc.GetDocFlag("log-level").Description,
+		rootCmd.GetDocFlag("log-level").Name,
+		rootCmd.GetDocFlag("log-level").Default,
+		rootCmd.GetDocFlag("log-level").Description,
 	)
 	RootCmd.PersistentFlags().StringVar(
 		&clientCredsFile,
-		doc.GetDocFlag("with-client-creds-file").Name,
-		doc.GetDocFlag("with-client-creds-file").Default,
-		doc.GetDocFlag("with-client-creds-file").Description,
+		rootCmd.GetDocFlag("with-client-creds-file").Name,
+		rootCmd.GetDocFlag("with-client-creds-file").Default,
+		rootCmd.GetDocFlag("with-client-creds-file").Description,
 	)
 	RootCmd.PersistentFlags().StringVar(
 		&clientCredsJSON,
-		doc.GetDocFlag("with-client-creds").Name,
-		doc.GetDocFlag("with-client-creds").Default,
-		doc.GetDocFlag("with-client-creds").Description,
+		rootCmd.GetDocFlag("with-client-creds").Name,
+		rootCmd.GetDocFlag("with-client-creds").Default,
+		rootCmd.GetDocFlag("with-client-creds").Description,
 	)
 	RootCmd.AddGroup(&cobra.Group{ID: "tdf"})
 }

docs/man/_index.md

@@ -4,6 +4,9 @@ title: otdfctl - OpenTDF Control Tool
 command:
   name: otdfctl
   flags:
+    - name: version
+      description: show version
+      default: false
     - name: host
       description: Hostname of the platform (i.e. https://localhost)
       default:

internal/config/config.go renamed to pkg/config/config.go

@@ -11,6 +11,12 @@ import (
 	"github.com/spf13/viper"
 )
 
+var AppName = "otdfctl"
+
+var Version = "0.0.0"
+var BuildTime = "1970-01-01T00:00:00Z"
+var CommitSha = "0000000"
+
 type Output struct {
 	Format string `yaml:"format" default:"styled"`
 }