feat: derive build version from git tag + cleanup

Author: AzraelSec

.gitignore

@@ -20,6 +20,8 @@
 # Go workspace file
 go.work
 
+.env
+
 bin/
 
 dist/

.goreleaser.yaml

@@ -1,9 +1,15 @@
+version: 2
 before:
   hooks:
     - go mod tidy
 builds:
   - env:
       - CGO_ENABLED=0
+    flags:
+      - -trimpath
+    ldflags:
+      - -s -w -X github.com/AzraelSec/glock/cmd/cli/commands.Version={{ .Version }}
+    mod_timestamp: "{{ .CommitTimestamp }}"
     goos:
       - linux
       # - windows
@@ -12,25 +18,22 @@ builds:
     binary: glock
 
 archives:
-  - format: tar.gz
+  - formats: ["tar.gz"]
     name_template: >-
       {{ .ProjectName }}_
+      {{- .Version }}_
       {{- title .Os }}_
       {{- if eq .Arch "amd64" }}x86_64
       {{- else if eq .Arch "386" }}i386
       {{- else }}{{ .Arch }}{{ end }}
       {{- if .Arm }}v{{ .Arm }}{{ end }}
-    # # use zip for windows archives
-    # format_overrides:
-    # - goos: windows
-    #   format: zip
 checksum:
-  name_template: 'checksums.txt'
+  name_template: "{{ .ProjectName }}_{{ .Version }}_checksums.txt"
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
   sort: asc
   filters:
     exclude:
-      - '^docs:'
-      - '^test:'
+      - "^docs:"
+      - "^test:"

Makefile

@@ -1,22 +1,40 @@
-.PHONY: test build install run compile
+include .env
+
+.PHONY: test build install run clean compile release
+
+VERSION ?= $(patsubst v%,%,$(shell git describe --tags --exact-match 2>/dev/null || echo dev))
+LD_FLAGS := -X github.com/AzraelSec/glock/cmd/cli/commands.Version=$(VERSION)
+RELEASE_TAG := $(if $(filter v%,$(VERSION)),$(VERSION),v$(VERSION))
 
 test:
 	go test ./...
 
 build:
-	go build -o glock cmd/cli/main.go
+	go build -ldflags "$(LD_FLAGS)" -o glock ./cmd/cli
 
 install: build
 	cp glock ~/.local/bin/glock
 
 run:
-	go run main.go
+	go run -ldflags "$(LD_FLAGS)" ./cmd/cli
 
 clean:
-	rm glock
+	rm -f glock
 
 compile:
 	echo "Compiling for every OS and Platform"
-	GOOS=linux GOARCH=arm go build -o bin/glock-linux-arm cmd/cli/main.go
-	GOOS=linux GOARCH=arm64 go build -o bin/main-linux-arm64 cmd/cli/main.go
+	GOOS=linux GOARCH=arm go build -ldflags "$(LD_FLAGS)" -o bin/glock-linux-arm ./cmd/cli
+	GOOS=linux GOARCH=arm64 go build -ldflags "$(LD_FLAGS)" -o bin/glock-linux-arm64 ./cmd/cli
 
+release:
+	@test -n "$(VERSION)" || (printf "Usage: make release VERSION=0.1.0\n" >&2; exit 1)
+	@test "$$(git rev-parse --abbrev-ref HEAD)" = "main" || (printf "Release must run from main\n" >&2; exit 1)
+	@test -z "$$(git status --porcelain)" || (printf "Working tree must be clean\n" >&2; exit 1)
+	@git fetch origin main --tags
+	@git pull --ff-only origin main
+	@if git rev-parse "$(RELEASE_TAG)" >/dev/null 2>&1; then printf "Tag %s already exists\n" "$(RELEASE_TAG)" >&2; exit 1; fi
+	@if git ls-remote --exit-code --tags origin "refs/tags/$(RELEASE_TAG)" >/dev/null 2>&1; then printf "Remote tag %s already exists\n" "$(RELEASE_TAG)" >&2; exit 1; fi
+	@go test ./...
+	@git tag "$(RELEASE_TAG)"
+	@git push origin main "$(RELEASE_TAG)"
+	@goreleaser release --clean

cmd/cli/commands/root.go

@@ -16,16 +16,17 @@ import (
 
 const (
 	CONFIG_PATH_ENV       = "GLOCK_CONFIG_PATH"
-	VERSION               = "0.0.1"
 	CONFIG_FILE_NAME      = "glock.yml"
 	MAX_CONFIG_FILE_DEPTH = 20
 )
 
+var Version = "dev"
+
 var rootCmd = &cobra.Command{
 	Use:          "glock",
 	Short:        "Shooting flies with a bazooka \U0001f680",
 	SilenceUsage: true,
-	Version:      VERSION,
+	Version:      Version,
 }
 
 type RedWriter struct {