Merge pull request #16 from chez-shanpu/prepare-release

Prepare for releases

Author: chez-shanpu

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: '1.24'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          check-latest: true
+
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          distribution: goreleaser
+          version: "~> v2"
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yml

@@ -0,0 +1,102 @@
+version: 2
+
+before:
+  hooks:
+    - go mod tidy
+
+builds:
+  - id: kubectl-mft
+    binary: kubectl-mft
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+    ldflags:
+      - -s -w
+      - -X github.com/chez-shanpu/kubectl-mft/cmd.version={{.Version}}
+      - -X github.com/chez-shanpu/kubectl-mft/cmd.commit={{.ShortCommit}}
+    mod_timestamp: "{{ .CommitTimestamp }}"
+
+archives:
+  - id: kubectl-mft
+    formats: tar.gz
+    # use zip for windows archives
+    format_overrides:
+      - goos: windows
+        formats: zip
+    name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
+    files:
+      - README.md
+      - LICENSE
+
+changelog:
+  use: github
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+      - "^ci:"
+      - Merge pull request
+      - Merge branch
+  groups:
+    - title: Features
+      regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
+      order: 0
+    - title: "Bug Fixes"
+      regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
+      order: 1
+    - title: Others
+      order: 999
+
+checksum:
+  name_template: "checksums.txt"
+  algorithm: sha256
+
+release:
+  github:
+    owner: chez-shanpu
+    name: kubectl-mft
+  draft: false
+  prerelease: auto
+  mode: append
+  header: |
+    ## kubectl-mft {{ .Tag }}
+
+    Release of kubectl-mft version {{ .Tag }}.
+
+  footer: |
+    ## Installation
+
+    ### Download Binary
+
+    **Linux / macOS**
+
+    ```bash
+    # Download and extract (replace OS and ARCH as needed)
+    curl -L https://github.com/chez-shanpu/kubectl-mft/releases/download/{{ .Tag }}/kubectl-mft_{{ .Tag }}_OS_ARCH.tar.gz | tar xz
+
+    # Move to a directory in your PATH
+    sudo mv kubectl-mft /usr/local/bin/
+
+    # Verify installation
+    kubectl mft version
+    ```
+
+    **Windows**
+
+    Download the `.zip` file for your architecture from the assets above, extract it, and add the binary to your PATH.
+
+    ### Using Go
+
+    ```bash
+    go install github.com/chez-shanpu/kubectl-mft@{{ .Tag }}
+    ```
+
+    ---
+
+    **Full Changelog**: https://github.com/chez-shanpu/kubectl-mft/compare/{{ .PreviousTag }}...{{ .Tag }}

Makefile

@@ -40,15 +40,19 @@ test-e2e:
 
 .PHONY: build
 build:
-	$(GO) build -o bin/ .
+	$(GO) build -ldflags "-X github.com/chez-shanpu/kubectl-mft/cmd.version=dev -X github.com/chez-shanpu/kubectl-mft/cmd.commit=$$(git rev-parse --short HEAD 2>/dev/null || echo 'none')" -o bin/ .
 
 .PHONY: clean
 clean:
 	-$(GO) clean
 	-rm $(RM_OPTS) $(BIN_DIR)
 
+.PHONY: check-goreleaser
+check-goreleaser:
+	goreleaser check
+
 .PHONY: check
-check: vet check-diff test
+check: vet check-diff test check-goreleaser
 
 .PHONY: check-all
 check-all: check test-e2e

README.md

@@ -55,6 +55,27 @@ kubectl mft dump -t localhost:5000/myapp/config:v1.0.0 | kubectl apply -f -
 
 ## Installation
 
+### Download Binary from GitHub Releases
+
+Download the latest release for your platform from [GitHub Releases](https://github.com/chez-shanpu/kubectl-mft/releases).
+
+**Linux / macOS**
+
+```bash
+# Download and extract (replace VERSION, OS, and ARCH as needed)
+curl -L https://github.com/chez-shanpu/kubectl-mft/releases/download/VERSION/kubectl-mft_VERSION_OS_ARCH.tar.gz | tar xz
+
+# Move to a directory in your PATH
+sudo mv kubectl-mft /usr/local/bin/
+
+# Verify installation
+kubectl mft version
+```
+
+**Windows**
+
+Download the `.zip` file for your architecture from the releases page, extract it, and add the binary to your PATH.
+
 ### Using Go
 
 ```bash
@@ -120,7 +141,11 @@ kubectl mft list -o yaml
 **Get file path to manifest blob**
 
 ```bash
+# Get the file path
 kubectl mft path -t localhost:5000/myapp:v1.0.0
+
+# Use with kubectl debug --custom
+kubectl debug mypod -it --image busyboz --custom=$(kubectl mft path -t localhost:5000/debug-container)
 ```
 
 **Delete a manifest**

aqua.yaml

@@ -13,3 +13,4 @@ registries:
 packages:
   - name: dominikh/go-tools/staticcheck@2025.1.1
   - name: golang/tools/goimports@v0.38.0
+  - name: goreleaser/goreleaser@v2.12.7

cmd/root.go

@@ -4,11 +4,18 @@
 package cmd
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/spf13/cobra"
 )
 
+var (
+	// Version information. These are set via ldflags during build.
+	version = "dev"
+	commit  = "none"
+)
+
 const (
 	TagFlag      = "tag"
 	TagShortFlag = "t"
@@ -28,6 +35,12 @@ var rootCmd = &cobra.Command{
 	Use:          "kubectl-mft",
 	Short:        "A kubectl plugin for managing Kubernetes manifests",
 	SilenceUsage: true,
+	Version:      version,
+}
+
+func init() {
+	// Customize version output template
+	rootCmd.SetVersionTemplate(fmt.Sprintf("kubectl-mft version %s (commit: %s)\n", version, commit))
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.