Merge pull request #27 from grishy/sg-fix-build-cli-version

grishy · web-flow · commit 040c809c44d5 · 2025-01-27T11:42:00.000+04:00
Bumpup Go and CI actions + fix version print
diff --git a/.github/workflows/commit.yml b/.github/workflows/commit.yml
@@ -9,33 +9,70 @@ permissions:
   contents: read
 
 jobs:
-  golangci:
-    runs-on: ubuntu-latest
+  test:
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "1.23.3"
-          cache: false
+          go-version: "1.23.5"
 
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+      - run: go mod verify
+
+      - run: go test -v ./...
+
+      - uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.62.0
-  build_test:
-    runs-on: ubuntu-latest
+          version: v1.63.4
+
+  build:
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "1.23.3"
-          cache: false
+          go-version: "1.23.5"
 
-      - name: Verify dependencies
-        run: go mod verify
+      - name: Set up QEMU for cross-compilation of Docker images
+        uses: docker/setup-qemu-action@v3
 
-      - name: Build
-        run: go build -v ./...
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
 
-      - name: Test
-        run: go test -v ./...
+      - run: go mod download
+
+      - uses: goreleaser/goreleaser-action@v6
+        id: goreleaser
+        with:
+          distribution: goreleaser
+          version: "~> v2"
+          args: release --skip=publish --clean --snapshot
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker base on Goreleaser
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/${{ github.repository }}
+          tags: |
+            type=raw,value=${{ fromJSON(steps.goreleaser.outputs.metadata).version }}
+
+      - name: Test build of Docker images
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: false
+          platforms: |
+            linux/amd64
+            linux/arm64
+            linux/arm/v7
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ fromJSON(steps.goreleaser.outputs.metadata).version }}
+            COMMIT=${{ fromJSON(steps.goreleaser.outputs.metadata).commit }}
+            DATE=${{ fromJSON(steps.goreleaser.outputs.metadata).date }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,49 +11,60 @@ permissions:
 
 jobs:
   release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/cheчckout@v4
         with:
           fetch-depth: 0
 
       - uses: actions/setup-go@v5
         with:
-          go-version: "1.23.3"
+          go-version: "1.23.5"
 
       - name: Set up QEMU for cross-compilation of Docker images
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Log in to the Container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: |
-            ghcr.io/${{ github.repository }}
-
-      - uses: goreleaser/goreleaser-action@v4
+      - uses: goreleaser/goreleaser-action@v6
+        id: goreleaser
         with:
           distribution: goreleaser
-          version: latest
+          version: "~> v2"
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build and push Docker images
-        uses: docker/build-push-action@v4
+      - name: Extract metadata (tags, labels) for Docker base on Goreleaser
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/${{ github.repository }}
+          tags: |
+            type=raw,value=${{ fromJSON(steps.goreleaser.outputs.metadata).version }}
+
+      - name: Test build of Docker images
+        uses: docker/build-push-action@v5
         with:
           context: .
-          push: true
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          platforms: |
+            linux/amd64
+            linux/arm64
+            linux/arm/v7
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ fromJSON(steps.goreleaser.outputs.metadata).version }}
+            COMMIT=${{ fromJSON(steps.goreleaser.outputs.metadata).commit }}
+            DATE=${{ fromJSON(steps.goreleaser.outputs.metadata).date }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,2 @@
+run:
+  timeout: 5m
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -5,13 +5,16 @@ version: 2
 report_sizes: true
 
 builds:
-  # https://goreleaser.com/customization/build/
+  # https://goreleaser.com/customization/builds/go/
   - env:
       - CGO_ENABLED=0
     flags:
       - -trimpath
     ldflags:
       - -w -s
+      - -X main.version={{.Version}}
+      - -X main.commit={{.ShortCommit}}
+      - -X main.date={{.CommitDate}}
     goos:
       - linux
       - darwin
@@ -20,15 +23,11 @@ builds:
       - "amd64"
       - "arm"
       - "arm64"
-    goarm:
-      - "6"
-      - "7"
     mod_timestamp: "{{ .CommitTimestamp }}"
 
 archives:
   # https://goreleaser.com/customization/archive/
-  - format: tar.gz
-    name_template: "{{ .ProjectName }}_v{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
+  - formats: ["tar.gz"]
 
 checksum:
   # https://goreleaser.com/customization/checksum/
@@ -39,7 +38,7 @@ release:
   target_commitish: "{{ .Commit }}"
   mode: replace
   header: |
-    ## ℹ️ For information on how to install and use please see `README.md`
+    ## ℹ️ For information on how to install and use please see [README.md](https://github.com/grishy/go-avahi-cname)
   footer: |
     Your PRs & issues are welcome! Thanks 😉
   disable: false
@@ -48,3 +47,19 @@ release:
 changelog:
   # https://goreleaser.com/customization/changelog/
   sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+      - "^ci:"
+      - Merge pull request
+      - Merge branch
+  groups:
+    - title: "New Features"
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 1
+    - title: Others
+      order: 999
diff --git a/Dockerfile b/Dockerfile
@@ -1,15 +1,27 @@
 # syntax=docker/dockerfile:1
 
+# NOTE: I build images for multi-arch because goreleaser works strange with multi-stage builds
+# Need a lot of additional configuration to build multi-arch images
+
 # STAGE 1: building the executable
-FROM docker.io/golang:1.23.3-alpine3.20 as builder
+FROM docker.io/golang:1.23.5-alpine3.20 AS builder
 WORKDIR /build
 
+ARG VERSION
+ARG COMMIT
+ARG DATE
+
 COPY go.mod go.sum ./
 RUN go mod download
 
-ENV CGO_ENABLED=0
 COPY . .
-RUN go build -ldflags="-w -s" -o /go-avahi-cname
+RUN CGO_ENABLED=0 \
+    go build \
+    -ldflags="-w -s \
+    -X main.version='${VERSION}' \
+    -X main.commit='${COMMIT}' \
+    -X main.date='${DATE}'" \
+    -o /go-avahi-cname
 
 # STAGE 2: build the container to run
 FROM scratch
diff --git a/go.mod b/go.mod
@@ -1,9 +1,9 @@
 module github.com/grishy/go-avahi-cname
 
-go 1.23.3
+go 1.23.5
 
 require (
-	github.com/earthboundkid/versioninfo/v2 v2.24.1
+	github.com/caarlos0/go-version v0.2.0
 	github.com/godbus/dbus/v5 v5.1.0
 	github.com/holoplot/go-avahi v1.0.1
 	github.com/lmittmann/tint v1.0.6
diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
+github.com/caarlos0/go-version v0.2.0 h1:TTD5dF3PBAtRHbfCKRE173SrVVpbE0yX95EDQ4BwTGs=
+github.com/caarlos0/go-version v0.2.0/go.mod h1:X+rI5VAtJDpcjCjeEIXpxGa5+rTcgur1FK66wS0/944=
 github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
-github.com/earthboundkid/versioninfo/v2 v2.24.1 h1:SJTMHaoUx3GzjjnUO1QzP3ZXK6Ee/nbWyCm58eY3oUg=
-github.com/earthboundkid/versioninfo/v2 v2.24.1/go.mod h1:VcWEooDEuyUJnMfbdTh0uFN4cfEIg+kHMuWB2CDCLjw=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
 github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
diff --git a/main.go b/main.go
@@ -9,15 +9,25 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/earthboundkid/versioninfo/v2"
+	goversion "github.com/caarlos0/go-version"
 	"github.com/lmittmann/tint"
 	"github.com/mattn/go-isatty"
 	"github.com/urfave/cli/v2"
 
 	"github.com/grishy/go-avahi-cname/cmd"
 )
 
-const forceExitTimeout = 3 * time.Second
+const (
+	forceExitTimeout = 5 * time.Second
+	appName          = "go-avahi-cname"
+)
+
+// Version information set during build
+var (
+	version = "dev"
+	commit  = "none"
+	date    = "unknown"
+)
 
 func main() {
 	ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
@@ -28,24 +38,41 @@ func main() {
 	if err := run(ctx); err != nil {
 		fmt.Println("Error:")
 		fmt.Printf(" > %+v\n", err)
+		os.Exit(1)
 	}
 }
 
-// run starts the CLI application
+// run starts and configures the CLI application
 func run(ctx context.Context) error {
+	cli.VersionPrinter = func(c *cli.Context) {
+		fmt.Print(buildVersion().String())
+	}
+
 	app := &cli.App{
-		Name:    "go-avahi-cname",
-		Usage:   "A tool for publishing CNAME records with Avahi",
-		Version: versioninfo.Short(),
+		Name:    appName,
+		Usage:   "Create local domain names using Avahi daemon",
+		Version: version,
+		Description: `A tool that helps you create local domain names for your computer by using the Avahi daemon.
+
+It works in two ways:
+1. Automatic mode (use 'subdomain' command): 
+   Any subdomain you try to use (like myapp.computer.local) will automatically point to your computer
+
+2. Manual mode (use 'cname' command):
+   You can create your own domain names that point to your computer and keep them active
+
+Need help? Visit https://github.com/grishy/go-avahi-cname`,
 		Authors: []*cli.Author{{
-			Name: "grishy",
+			Name:  "Sergei G.",
+			Email: "mail@grishy.dev",
 		}},
 		Flags: []cli.Flag{
 			&cli.BoolFlag{
 				Name:    "debug",
 				Aliases: []string{"d"},
 				Usage:   "Enable debug logging",
 				EnvVars: []string{"DEBUG"},
+				Value:   false,
 			},
 		},
 		Before: setupLogger,
@@ -58,7 +85,7 @@ func run(ctx context.Context) error {
 	return app.Run(os.Args)
 }
 
-// handleGracefulShutdown handles graceful shutdown with timeout
+// handleGracefulShutdown manages graceful shutdown with timeout
 func handleGracefulShutdown(ctx context.Context) {
 	<-ctx.Done()
 	slog.Info("initiating graceful shutdown...")
@@ -74,7 +101,7 @@ func handleGracefulShutdown(ctx context.Context) {
 	}
 }
 
-// setupLogger configures the global logger with appropriate settings
+// setupLogger configures the global structured logger with appropriate settings
 func setupLogger(c *cli.Context) error {
 	w := os.Stdout
 	level := slog.LevelInfo
@@ -92,3 +119,14 @@ func setupLogger(c *cli.Context) error {
 
 	return nil
 }
+
+// buildVersion constructs version information for the application
+func buildVersion() goversion.Info {
+	return goversion.GetVersionInfo(
+		func(i *goversion.Info) {
+			i.GitCommit = commit
+			i.BuildDate = date
+			i.GitVersion = version
+		},
+	)
+}
