feat: Add more build metadata like commit hash, commit date, build date and git tag (#121)

* feat: Add more build metadata to Capture and API response #92

- CLI: 'capture --version'
- API: GET /api/v1/metrics | jq '.capture'

Signed-off-by: Mert Şişmanoğlu <[email protected]>

* fix: use YAML anchors for ldflags configuration for 'builds' and 'kos' in goreleaser

Signed-off-by: Mert Şişmanoğlu <[email protected]>

* fix: Show metadata at only CLI mode and delete GitTagURL

Signed-off-by: Mert Şişmanoğlu <[email protected]>

---------

Signed-off-by: Mert Şişmanoğlu <[email protected]>

Author: mertssmnoglu

.goreleaser.yml

@@ -4,10 +4,14 @@ project_name: capture
 builds:
   - id: capture
     main: ./cmd/capture
-    ldflags:
+    ldflags: &common_ldflags
       - -s -w
       - -extldflags "-static"
       - -X "main.Version={{.Version}}"
+      - -X "main.Commit={{.Commit}}"
+      - -X "main.CommitDate={{.CommitDate}}"
+      - -X "main.CompiledAt={{.Date}}"
+      - -X "main.GitTag={{.Tag}}"
     env:
       - CGO_ENABLED=0
     goos:
@@ -39,10 +43,7 @@ kos:
     main: ./cmd/capture
     flags:
       - -trimpath
-    ldflags:
-      - -s -w
-      - -extldflags "-static"
-      - -X "main.Version={{.Version}}"
+    ldflags: *common_ldflags
     creation_time: "{{.CommitTimestamp}}"
     sbom: spdx
     env:

cmd/capture/main.go

@@ -12,17 +12,42 @@ import (
 	"github.com/bluewave-labs/capture/internal/server/handler"
 )
 
+// Application configuration variable that holds the settings.
+//
+//   - Port: Server port, default is 59232
+//
+//   - APISecret: Secret key for API access, default is a blank string.
 var appConfig *config.Config
 
-var Version = "develop" // This will be set during compile time using go build ldflags
+// Build information variables populated at build time.
+// These variables are typically set using ldflags during the build process
+// to provide runtime access to build metadata.
+var (
+	// Version represents the Capture version (default: "develop").
+	Version = "develop"
+	// Commit contains the Git commit hash of the build.
+	Commit = "unknown"
+	// CommitDate holds the date of the commit.
+	CommitDate = "unknown"
+	// CompiledAt stores the build compilation date.
+	CompiledAt = "unknown"
+	// GitTag contains the Git tag associated with the build, if any.
+	GitTag = "unknown"
+)
 
 func main() {
 	showVersion := flag.Bool("version", false, "Display the version of the capture")
 	flag.Parse()
 
-	// Check if the version flag is provided
+	// Check if the version flag is provided and show build information
 	if *showVersion {
-		fmt.Printf("Capture version: %s\n", Version)
+		fmt.Println("Capture Build Information")
+		fmt.Println("-------------------------")
+		fmt.Printf("Version          : %s\n", Version)
+		fmt.Printf("Commit Hash      : %s\n", Commit)
+		fmt.Printf("Commit Date      : %s\n", CommitDate)
+		fmt.Printf("Compiled At      : %s\n", CompiledAt)
+		fmt.Printf("Git Tag          : %s\n", GitTag)
 		os.Exit(0)
 	}