feature: Add version command

Author: andrzej-janczak

.github/workflows/go.yml

@@ -9,17 +9,29 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for git history
       - name: Set up Go
         uses: actions/setup-go@v4
+      - name: Set version info
+        id: version
+        run: |
+          VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "development")
+          COMMIT=$(git rev-parse --short HEAD 2>/dev/null || echo "unknown")
+          BUILD_TIME=$(date -u '+%Y-%m-%d_%H:%M:%S')
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+          echo "COMMIT=${COMMIT}" >> $GITHUB_ENV
+          echo "BUILD_TIME=${BUILD_TIME}" >> $GITHUB_ENV
+          echo "LDFLAGS=-X 'codacy/cli-v2/version.Version=${VERSION}' -X 'codacy/cli-v2/version.GitCommit=${COMMIT}' -X 'codacy/cli-v2/version.BuildTime=${BUILD_TIME}'" >> $GITHUB_ENV
       - name: Build CLI for Linux
         run: |
-          GOOS=linux GOARCH=amd64 go build -o cli-v2-linux ./cli-v2.go
+          GOOS=linux GOARCH=amd64 go build -ldflags "${LDFLAGS}" -o cli-v2-linux ./cli-v2.go
       - name: Build CLI for Windows
         run: |
-          GOOS=windows GOARCH=amd64 go build -o cli-v2.exe ./cli-v2.go
+          GOOS=windows GOARCH=amd64 go build -ldflags "${LDFLAGS}" -o cli-v2.exe ./cli-v2.go
       - name: Build CLI for macOS
         run: |
-          GOOS=darwin GOARCH=amd64 go build -o cli-v2-macos ./cli-v2.go
+          GOOS=darwin GOARCH=amd64 go build -ldflags "${LDFLAGS}" -o cli-v2-macos ./cli-v2.go
       - name: Upload CLI binaries
         uses: actions/upload-artifact@v4
         with:

Makefile

@@ -0,0 +1,23 @@
+.PHONY: build clean
+
+# Get the version from git describe or fallback to a default version
+VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "development")
+COMMIT := $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
+BUILD_TIME := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
+
+# Build flags
+LDFLAGS := -X 'codacy/cli-v2/version.Version=$(VERSION)' -X 'codacy/cli-v2/version.GitCommit=$(COMMIT)' -X 'codacy/cli-v2/version.BuildTime=$(BUILD_TIME)'
+
+# Build the CLI
+build:
+	go build -ldflags "$(LDFLAGS)" -o cli-v2
+
+# Clean build artifacts
+clean:
+	rm -f cli-v2
+
+# Build for all platforms
+build-all: clean
+	GOOS=linux GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2_linux_amd64
+	GOOS=darwin GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2_darwin_amd64
+	GOOS=windows GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2_windows_amd64.exe 

cli-v2.go

@@ -5,6 +5,7 @@ import (
 	"codacy/cli-v2/config"
 	config_file "codacy/cli-v2/config-file"
 	"codacy/cli-v2/utils/logger"
+	"codacy/cli-v2/version"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -22,8 +23,10 @@ func main() {
 		fmt.Printf("Failed to initialize logger: %v\n", err)
 	}
 
-	// Log startup message
-	logger.Debug("Starting Codacy CLI.", logrus.Fields{})
+	// Log startup message and version
+	logger.Info("Starting Codacy CLI", logrus.Fields{
+		"version": version.GetVersion(),
+	})
 
 	// This also setup the config global !
 	configErr := config_file.ReadConfigFile(config.Config.ProjectConfigFile())

cmd/root.go

@@ -7,14 +7,15 @@ import (
 
 	"codacy/cli-v2/config"
 	"codacy/cli-v2/utils/logger"
+	"codacy/cli-v2/version"
 
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 )
 
 var rootCmd = &cobra.Command{
 	Use:     "codacy-cli",
-	Short:   "Codacy CLI - A command line interface for Codacy",
+	Short:   fmt.Sprintf("Codacy CLI v%s - A command line interface for Codacy", version.GetVersion()),
 	Long:    "",
 	Example: getExampleText(),
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {

cmd/version.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	"codacy/cli-v2/version"
+	"fmt"
+	"runtime"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Display version information",
+	Run: func(cmd *cobra.Command, args []string) {
+		bold := color.New(color.Bold)
+		cyan := color.New(color.FgCyan)
+
+		fmt.Println()
+		bold.Println("Codacy CLI Version Information")
+		fmt.Println("-----------------------------")
+		cyan.Printf("Version:    ")
+		fmt.Println(version.Version)
+		cyan.Printf("Commit:     ")
+		fmt.Println(version.GitCommit)
+		cyan.Printf("Built:      ")
+		fmt.Println(version.BuildTime)
+		cyan.Printf("Go version: ")
+		fmt.Println(runtime.Version())
+		cyan.Printf("OS/Arch:    ")
+		fmt.Printf("%s/%s\n", runtime.GOOS, runtime.GOARCH)
+		fmt.Println()
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

version/version.go

@@ -0,0 +1,21 @@
+package version
+
+// Version information set at build time
+var (
+	// Version is the current version of codacy-cli
+	Version = "development"
+
+	// GitCommit is the git commit hash of the build
+	GitCommit = "unknown"
+
+	// BuildTime is the time the binary was built
+	BuildTime = "unknown"
+)
+
+// GetVersion returns the current version of codacy-cli
+func GetVersion() string {
+	if GitCommit != "unknown" {
+		return Version + " (" + GitCommit + ") built at " + BuildTime
+	}
+	return Version
+}