feat: add cli release workflow (#43)

* feat: add cli release step

* doc: add release step doc

Author: bcho

.github/workflows/cli-release.yaml

@@ -0,0 +1,47 @@
+name: Release CLI
+
+on:
+  push:
+    tags:
+      - "cli/v*"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: cli/go.mod
+          cache-dependency-path: cli/go.sum
+
+      - name: Extract version from tag
+        id: version
+        run: |
+          # Strip the "cli/" prefix from the tag to get the semver (e.g. cli/v1.2.3 -> v1.2.3)
+          TAG="${GITHUB_REF#refs/tags/}"
+          VERSION="${TAG#cli/}"
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
+
+      - name: Install GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          install-only: true
+          version: "~> v2"
+
+      - name: Run GoReleaser
+        working-directory: cli
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GORELEASER_CURRENT_TAG: ${{ steps.version.outputs.version }}
+        run: goreleaser release --clean

cli/.goreleaser.yml

@@ -50,4 +50,4 @@ changelog:
       - "^test:"
 
 release:
-  disable: true
+  name_template: "CLI {{ .Version }}"

docs/dev/release.md

@@ -0,0 +1,109 @@
+# Release Guide
+
+This document covers how to create releases for each component in the repository.
+
+## Tag Convention
+
+Each component uses a prefixed tag to trigger its release workflow:
+
+| Component | Tag pattern | Example | Workflow |
+|-----------|------------|---------|----------|
+| CLI | `cli/v<semver>` | `cli/v1.2.3` | `.github/workflows/cli-release.yaml` |
+| Karpenter | `karpenter/v<semver>` | `karpenter/v0.5.0` | `.github/workflows/karpenter-publish.yaml` |
+
+All tags must follow [Semantic Versioning](https://semver.org/).
+
+---
+
+## CLI Release
+
+The CLI release workflow builds cross-platform binaries with [GoReleaser](https://goreleaser.com/) and publishes them as a GitHub Release.
+
+### Artifacts
+
+Each release includes:
+
+- `aks-flex-cli_<version>_linux_amd64.tar.gz`
+- `aks-flex-cli_<version>_linux_arm64.tar.gz`
+- `aks-flex-cli_<version>_darwin_arm64.tar.gz`
+- `checksums.txt`
+- Auto-generated changelog
+
+### Steps
+
+1. Make sure all changes are merged to `main`.
+
+2. Decide on a version number following semver (e.g. `v1.0.0`).
+
+3. Create and push the tag:
+
+   ```bash
+   git tag cli/v1.0.0
+   git push origin cli/v1.0.0
+   ```
+
+4. The [Release CLI](.../../.github/workflows/cli-release.yaml) workflow runs automatically. Monitor it in the **Actions** tab.
+
+5. Once complete, the GitHub Release appears under **Releases** with all binary archives attached.
+
+### Local Snapshot Build
+
+To build binaries locally without publishing:
+
+```bash
+cd cli
+make build           # binaries only
+make build-archives  # binaries + tar.gz archives
+```
+
+Snapshot builds append a `-snapshot-<commit>` suffix to the version.
+
+---
+
+## Karpenter Release
+
+The Karpenter workflow builds a multi-platform Docker image and pushes it to GHCR.
+
+### Image
+
+```
+ghcr.io/<owner>/aks-flex/karpenter:<tag>
+```
+
+### Triggers
+
+The workflow runs on:
+
+- Push to `main` when files under `karpenter/` or `plugin/` change (tagged as `main` and `sha-<short>`).
+- A `karpenter/v*` tag push (tagged with the semver and `latest`).
+- Manual `workflow_dispatch`.
+
+### Steps
+
+1. Make sure all changes are merged to `main`.
+
+2. Decide on a version number (e.g. `v0.5.0`).
+
+3. Create and push the tag:
+
+   ```bash
+   git tag karpenter/v0.5.0
+   git push origin karpenter/v0.5.0
+   ```
+
+4. The [Publish Karpenter Image](../../.github/workflows/karpenter-publish.yaml) workflow runs automatically.
+
+5. Once complete, the image is available at:
+
+   ```
+   ghcr.io/<owner>/aks-flex/karpenter:0.5.0
+   ghcr.io/<owner>/aks-flex/karpenter:latest
+   ```
+
+---
+
+## Troubleshooting
+
+- **Workflow did not trigger** -- Verify the tag matches the expected pattern exactly (`cli/v*` or `karpenter/v*`). Tags like `CLI/v1.0.0` or `v1.0.0` without a prefix will not trigger the workflows.
+- **GoReleaser fails with "tag is not a semver"** -- Ensure the portion after the prefix is valid semver (e.g. `v1.2.3`, not `v1.2`).
+- **Permission denied on release** -- The workflow requires `contents: write` permission. This is configured in the workflow file but may need to be allowed in the repository settings if the default token permissions are restricted.