Add Zarf Version to CLI options

cli/Makefile

@@ -6,10 +6,11 @@
 # test: deps
 # 	gotestsum
 
+CLI_VERSION := $(if $(shell git describe), $(shell git describe), "UnknownVersion")
+
 build:
 	mkdir -p ../build
-	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -o ../build/zarf main.go
-
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w -X 'github.com/defenseunicorns/zarf/cli/config.CLIVersion=$(CLI_VERSION)'" -o ../build/zarf main.go
 build-mac:
 	mkdir -p ../build
 	GOOS=darwin GOARCH=arm64 go build -ldflags="-s -w" -o ../build/zarf-mac-apple main.go

cli/cmd/version.go

@@ -0,0 +1,20 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/defenseunicorns/zarf/cli/config"
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Displays the version the zarf binary was built from",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println(config.CLIVersion)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

cli/config/config.go

@@ -21,6 +21,7 @@ const ZarfLocalIP = "127.0.0.1"
 const ZarfGitUser = "zarf-git-user"
 
 var config ZarfConfig
+var CLIVersion = "unset"
 
 func IsZarfInitConfig() bool {
 	return strings.ToLower(config.Kind) == "zarfinitconfig"
@@ -71,6 +72,9 @@ func WriteConfig(path string) {
 	// Record the time of package creation
 	config.Package.Timestamp = now.Format(time.RFC1123Z)
 
+	// Record the Zarf Version the CLI was built with
+	config.Package.Version = CLIVersion
+
 	if hostErr == nil {
 		// Record the hostname of the package creation terminal
 		config.Package.Terminal = hostname

cli/config/types.go

@@ -48,6 +48,7 @@ type ZarfBuildData struct {
 	Terminal  string `yaml:"terminal"`
 	User      string `yaml:"user"`
 	Timestamp string `yaml:"timestamp"`
+	Version   string `yaml:"string"`
 }
 
 type ZarfConfig struct {

test/e2e/e2e_general_cli_test.go

@@ -72,4 +72,11 @@ func testGeneralCliStuff(t *testing.T, terraformOptions *terraform.Options, keyP
   output,err = ssh.CheckSshCommandE(t, publicHost, fmt.Sprintf("cd /home/%s/build && ./zarf prepare sha256sum https://zarf-public.s3-us-gov-west-1.amazonaws.com/pipelines/zarf-prepare-shasum-remote-test-file.txt 2> /dev/null", username))
   require.NoError(t, err, output)
   assert.Equal(t, expectedShasum, output, "The expected SHASUM should equal the actual SHASUM")
+
+  // Test `zarf version`
+  output, err = ssh.CheckSshCommandE(t, publicHost, fmt.Sprintf("cd /home/%s/build && ./zarf version", username))
+  require.NoError(t, err, output)
+  assert.NotNil(t, output)
+  assert.NotEqual(t, len(output), 0, "Zarf version should not be an empty string")
+  assert.NotEqual(t, string(output), "UnknownVersion", "Zarf version should not be the default value")
 }