Merge pull request #35 from andreagrandi/install-smoke-tests

Add install smoke tests for go install, release artifacts, and Homebrew formula

Author: andreagrandi

.github/workflows/install-smoke-tests.yml

@@ -0,0 +1,102 @@
+name: Install Smoke Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  go-install:
+    name: Go install smoke test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.26.1'
+
+      - name: Install via go install
+        run: go install ./cmd/mb-cli
+
+      - name: Verify mb-cli --help
+        run: |
+          MBCLI_BIN="$(go env GOPATH)/bin/mb-cli"
+          "$MBCLI_BIN" --help
+
+      - name: Verify mb-cli version
+        run: |
+          MBCLI_BIN="$(go env GOPATH)/bin/mb-cli"
+          "$MBCLI_BIN" version
+
+  release-artifacts:
+    name: Release artifacts smoke test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.26.1'
+
+      - name: Install GoReleaser
+        uses: goreleaser/goreleaser-action@v7
+        with:
+          distribution: goreleaser
+          version: '~> v2'
+          install-only: true
+
+      - name: Build release artifacts
+        run: goreleaser release --snapshot --clean
+
+      - name: Verify Linux amd64 release binary
+        run: |
+          ./dist/mb-cli_linux_amd64_v1/mb-cli --help
+          ./dist/mb-cli_linux_amd64_v1/mb-cli version
+
+      - name: Verify release archives exist
+        run: |
+          test -f dist/mb-cli_Linux_x86_64.tar.gz
+          test -f dist/mb-cli_Linux_arm64.tar.gz
+          test -f dist/mb-cli_Darwin_x86_64.tar.gz
+          test -f dist/mb-cli_Darwin_arm64.tar.gz
+          test -f dist/mb-cli_Windows_x86_64.zip
+          test -f dist/checksums.txt
+
+  homebrew-formula:
+    name: Homebrew formula smoke test
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.26.1'
+
+      - name: Install GoReleaser
+        uses: goreleaser/goreleaser-action@v7
+        with:
+          distribution: goreleaser
+          version: '~> v2'
+          install-only: true
+
+      - name: Generate Homebrew formula
+        run: goreleaser release --snapshot --clean
+
+      - name: Verify formula syntax
+        run: ruby -c dist/homebrew/Formula/mb-cli.rb

AGENTS.md

@@ -225,6 +225,11 @@ git tag v<version>
 git push origin v<version>
 ```
 
+8. After the release workflow finishes, verify the public install paths:
+
+- Follow the manual release checks in `docs/RELEASE.md`.
+- Confirm `go install`, Homebrew, and binary downloads all produce a working `mb-cli --help` and `mb-cli version`.
+
 Notes:
 
 - The tag push triggers `.github/workflows/release.yml`.

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+- Add install smoke tests for `go install`, release artifacts, and the generated Homebrew formula, plus release verification docs in `docs/RELEASE.md` (#19)
+
 ## [0.3.0] - 2026-05-22
 
 - Add `docs/RECIPES.md` with worked end-to-end recipes for schema discovery, saved-question inspection, dashboard analysis, parameterized card/dashboard runs, and PII-safe querying, linked from the README (#16)

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build test test-verbose fmt vet lint clean deps build-all help
+.PHONY: build test test-verbose fmt vet lint clean deps build-all install-smoke-tests help
 
 BINARY_NAME := mb-cli
 BUILD_DIR := bin
@@ -44,6 +44,9 @@ build-all:
 	@GOOS=darwin GOARCH=arm64 go build -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 $(MAIN_PKG)
 	@GOOS=windows GOARCH=amd64 go build -o $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe $(MAIN_PKG)
 
+install-smoke-tests:
+	@scripts/install-smoke-tests.sh
+
 help:
 	@echo "Available targets:"
 	@echo "  build        - Build the binary to bin/"
@@ -55,4 +58,5 @@ help:
 	@echo "  clean        - Remove build artifacts"
 	@echo "  deps         - Download and tidy dependencies"
 	@echo "  build-all    - Cross-platform builds"
+	@echo "  install-smoke-tests - Run install path smoke tests"
 	@echo "  help         - Show this help"

docs/RELEASE.md

@@ -0,0 +1,44 @@
+# Release Verification
+
+This document describes how to verify that the public install paths for `mb-cli` produce a working binary.
+
+## Automated smoke tests
+
+The [Install Smoke Tests](../.github/workflows/install-smoke-tests.yml) workflow runs on every push and pull request:
+
+- `go install` from the local source tree builds an `mb-cli` binary and runs `mb-cli --help` and `mb-cli version`.
+- GoReleaser builds release artifacts in snapshot mode, the Linux amd64 binary is executed, and the expected archives and checksum file are checked.
+- The generated Homebrew formula is syntax-checked with `ruby -c`.
+
+These tests do not require Metabase credentials.
+
+## Manual release checks
+
+After a release is published, verify the public install paths:
+
+### Go install
+
+```bash
+go install github.com/andreagrandi/mb-cli/cmd/mb-cli@latest
+$(go env GOPATH)/bin/mb-cli --help
+$(go env GOPATH)/bin/mb-cli version
+```
+
+### Homebrew
+
+```bash
+brew update
+brew install andreagrandi/tap/mb-cli
+mb-cli --help
+mb-cli version
+```
+
+### Binary download
+
+1. Download the archive for your platform from the [releases page](https://github.com/andreagrandi/mb-cli/releases).
+2. Extract the `mb-cli` binary.
+3. Run `./mb-cli --help` and `./mb-cli version`.
+
+### Expected output
+
+Both `mb-cli --help` and `mb-cli version` must exit with status `0` and print the help text and version respectively.

scripts/install-smoke-tests.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+cd "$REPO_ROOT"
+
+GO_BIN="${GO_BIN:-go}"
+GORELEASER_BIN="${GORELEASER_BIN:-goreleaser}"
+
+fail() {
+	echo "FAIL: $*" >&2
+	exit 1
+}
+
+echo "==> Smoke testing go install from local source..."
+"$GO_BIN" install ./cmd/mb-cli
+MBCLI_BIN=$("$GO_BIN" env GOPATH)/bin/mb-cli
+test -x "$MBCLI_BIN" || fail "mb-cli binary not found at $MBCLI_BIN"
+"$MBCLI_BIN" --help >/dev/null || fail "mb-cli --help failed"
+"$MBCLI_BIN" version >/dev/null || fail "mb-cli version failed"
+echo "    go install smoke test passed"
+
+if command -v "$GORELEASER_BIN" >/dev/null 2>&1; then
+	echo "==> Smoke testing release artifacts with GoReleaser snapshot..."
+	"$GORELEASER_BIN" release --snapshot --clean
+
+	GOOS=$("$GO_BIN" env GOOS)
+	GOARCH=$("$GO_BIN" env GOARCH)
+	mapfile -d '' -t candidates < <(find dist -type f \( -name 'mb-cli' -o -name 'mb-cli.exe' \) -path "*mb-cli_${GOOS}_${GOARCH}_*" -print0)
+	test ${#candidates[@]} -gt 0 || fail "no release binary found for $GOOS/$GOARCH"
+	BINARY=${candidates[0]}
+	test -x "$BINARY" || fail "release binary is not executable: $BINARY"
+	"$BINARY" --help >/dev/null || fail "release binary --help failed"
+	"$BINARY" version >/dev/null || fail "release binary version failed"
+
+	test -f dist/checksums.txt || fail "checksums.txt not found"
+	echo "    release artifacts smoke test passed"
+else
+	echo "    skipping GoReleaser smoke test (goreleaser not installed)"
+fi
+
+echo "==> All install smoke tests passed"