feat: add 'version' subcommand printing ldflags (version, commit, build time)\n\nci: pin goreleaser-action to '~> v2' and migrate GoReleaser config to v2 to remove deprecations

Author: yashbhutwala

.github/workflows/release.yml

@@ -27,7 +27,8 @@ jobs:
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v6
         with:
-          version: latest
+          # Pin to v2 line to avoid 'latest will lock to ~> v2' warning
+          version: "~> v2"
           args: release --clean --config deploy/.goreleaser.yaml
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

deploy/.goreleaser.yaml

@@ -1,41 +1,41 @@
-# Sources:
-# https://github.com/replicatedhq/outdated/blob/v0.3.3/deploy/.goreleaser.yaml
-project_name: kubectl-df-pv
+version: 2
+
+project: kubectl-df-pv
+
 release:
   github:
     owner: yashbhutwala
     name: kubectl-df-pv
+
 builds:
   - id: df-pv
-    goos:
-    - linux
-    - windows
-    - darwin
-    goarch:
-    - arm64
-    - amd64
-    - "386"
-    env:
-      - CGO_ENABLED=0
     main: cmd/df-pv/main.go
-    ldflags: -s -w
-      -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.version={{.Version}}
-      -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.gitSHA={{.Commit}}
-      -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.buildTime={{.Date}}
-      -extldflags "-static"
-    flags: -tags netgo -installsuffix netgo
     binary: df-pv
-    hooks: {}
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+      - "386"
+    flags:
+      - -tags=netgo
+      - -installsuffix
+      - netgo
+    ldflags:
+      - -s -w
+      - -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.version={{.Version}}
+      - -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.gitSHA={{.Commit}}
+      - -X github.com/yashbhutwala/kubectl-df-pv/pkg/version.buildTime={{.Date}}
+      - -extldflags "-static"
+
+# Let GoReleaser choose defaults per-OS (tar.gz for unix, zip for windows),
+# while ensuring common docs are embedded in the archives.
 archives:
-  - id: df-pv
-    builds:
-    - df-pv
-    format: tar.gz
-    format_overrides:
-    - goos: windows
-      format: zip
-    # name_template: '{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{.Arm }}{{ end }}-{{ .Major }}.{{ .Minor }}.{{ .Patch }}'
-    name_template: '{{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}'
+  - name_template: '{{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}'
     files:
       - licence*
       - LICENCE*

pkg/df-pv/root.go

@@ -19,6 +19,7 @@ import (
 	"github.com/pkg/errors"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/yashbhutwala/kubectl-df-pv/pkg/version"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -74,6 +75,16 @@ It colors the values based on "severity" [red: > 75% (too high); yellow: < 25% (
 		},
 	}
 
+	// version subcommand
+	var versionCmd = &cobra.Command{
+		Use:   "version",
+		Short: "Print version information",
+		Run: func(cmd *cobra.Command, args []string) {
+			fmt.Println(version.Info())
+		},
+	}
+	rootCmd.AddCommand(versionCmd)
+
 	rootCmd.PersistentFlags().StringVarP(&flags.logLevel, "verbosity", "v", "info", "log level; one of [info, debug, trace, warn, error, fatal, panic]")
 	rootCmd.Flags().BoolVarP(&flags.disableColor, "disable-color", "d", false, "boolean flag for disabling colored output")
 

pkg/version/version.go

@@ -8,12 +8,34 @@ var (
     buildTime = ""
 )
 
-// String returns a human-readable version string.
-func String() string {
-    v := version
-    if v == "" {
-        v = "dev"
+// Version returns the version string (e.g. v0.4.0 or dev).
+func Version() string {
+    if version == "" {
+        return "dev"
     }
-    return v
+    return version
 }
 
+// GitSHA returns the git commit SHA, if available.
+func GitSHA() string { return gitSHA }
+
+// BuildTime returns the build time, if available.
+func BuildTime() string { return buildTime }
+
+// String returns a human-readable version string.
+func String() string { return Version() }
+
+// Info returns a multi-field version line suitable for CLI output.
+func Info() string {
+    v := Version()
+    if gitSHA == "" && buildTime == "" {
+        return v
+    }
+    if gitSHA != "" && buildTime != "" {
+        return v + " (" + gitSHA + ", " + buildTime + ")"
+    }
+    if gitSHA != "" {
+        return v + " (" + gitSHA + ")"
+    }
+    return v + " (" + buildTime + ")"
+}