Merge pull request #2 from illegalstudio/feature/homebrew

feature/homebrew

Author: nahime0

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - uses: goreleaser/goreleaser-action@v6
+        with:
+          version: "~> v2"
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          HOMEBREW_TAP_TOKEN: ${{ secrets.HOMEBREW_TAP_TOKEN }}

.goreleaser.yaml

@@ -0,0 +1,42 @@
+version: 2
+
+builds:
+  - id: ggg
+    main: ./cmd/ggg
+    binary: ggg
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -s -w
+      - -X github.com/illegalstudio/ggg/internal/version.Version={{.Version}}
+      - -X github.com/illegalstudio/ggg/internal/version.Commit={{.ShortCommit}}
+    goos:
+      - darwin
+      - linux
+    goarch:
+      - amd64
+      - arm64
+
+archives:
+  - id: default
+    formats:
+      - tar.gz
+    files:
+      - README.md
+      - LICENSE
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+      - "^chore:"
+
+homebrew_casks:
+  - repository:
+      owner: illegalstudio
+      name: homebrew-tap
+      token: "{{ .Env.HOMEBREW_TAP_TOKEN }}"
+    homepage: https://github.com/illegalstudio/ggg
+    description: Clone and manage git repositories from a YAML configuration file

Makefile

@@ -3,11 +3,17 @@
 BINARY := ggg
 PKG    := ./cmd/ggg
 
+VERSION := $(shell git describe --tags --abbrev=0 2>/dev/null | sed 's/^v//' || echo dev)
+COMMIT  := $(shell git rev-parse --short HEAD 2>/dev/null || echo none)
+LDFLAGS := -s -w \
+           -X github.com/illegalstudio/ggg/internal/version.Version=$(VERSION) \
+           -X github.com/illegalstudio/ggg/internal/version.Commit=$(COMMIT)
+
 build:
-	go build -o $(BINARY) $(PKG)
+	go build -ldflags "$(LDFLAGS)" -o $(BINARY) $(PKG)
 
 install:
-	go install $(PKG)
+	go install -ldflags "$(LDFLAGS)" $(PKG)
 
 test:
 	go test ./...

README.md

@@ -11,11 +11,19 @@ GGG has a brother, [GGW](https://github.com/illegalstudio/ggw), that helps you m
 
 ## Installation
 
+### Homebrew
+
+```bash
+brew install illegalstudio/tap/ggg
+```
+
+### Go
+
 ```bash
 go install github.com/illegalstudio/ggg/cmd/ggg@latest
 ```
 
-Or build from source:
+### From source
 
 ```bash
 git clone https://github.com/illegalstudio/ggg.git
@@ -43,6 +51,9 @@ ggg list
 
 # Optional: enable gcd and shell completions
 eval "$(ggg shell-init zsh)"
+
+# Print the installed version
+ggg --version
 ```
 
 ## Commands

internal/cli/root.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/illegalstudio/ggg/internal/config"
+	"github.com/illegalstudio/ggg/internal/version"
 
 	"github.com/spf13/cobra"
 )
@@ -20,6 +21,7 @@ const (
 var rootCmd = &cobra.Command{
 	Use:           "ggg",
 	Short:         "Go Git Get — clone and manage git repositories from a config file",
+	Version:       version.String(),
 	SilenceErrors: true,
 	Long: `Go Git Get — clone and manage git repositories from a config file.
 
@@ -37,6 +39,7 @@ Use "ggg <command> --help" for details on any command.`,
 
 func init() {
 	rootCmd.PersistentFlags().BoolVar(&jsonOutput, "json", false, "Output in JSON format (suppresses spinners and prompts)")
+	rootCmd.SetVersionTemplate("{{.Version}}\n")
 }
 
 func Execute() {

internal/version/version.go

@@ -0,0 +1,14 @@
+package version
+
+import "fmt"
+
+// Set via ldflags at build time (see .goreleaser.yaml).
+var (
+	Version = "dev"
+	Commit  = "none"
+)
+
+// String returns a human-readable version string.
+func String() string {
+	return fmt.Sprintf("ggg v%s (%s)", Version, Commit)
+}