Merge pull request #155 from hookdeck/chore/update-goreleaser

feat: Implement Homebrew cask migration with dual distribution

Author: leggetter

.github/workflows/acceptance-test.yml renamed to .github/workflows/test-acceptance.yml

@@ -17,10 +17,10 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v3
         with:
-          go-version: '1.18'
+          go-version: "1.18"
 
       - name: Make script executable
-        run: chmod +x scripts/acceptance-test.sh
+        run: chmod +x test-scripts/test-acceptance.sh
 
       - name: Run acceptance tests
-        run: ./scripts/acceptance-test.sh
+        run: ./test-scripts/test-acceptance.sh

.github/workflows/test-homebrew-build.yml

@@ -0,0 +1,57 @@
+name: Homebrew Build and Installation Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+  workflow_dispatch:
+    inputs:
+      run_install_tests:
+        description: "Run installation tests"
+        required: false
+        default: "false"
+        type: choice
+        options:
+          - "false"
+          - "true"
+
+jobs:
+  test-homebrew-build:
+    runs-on: macos-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: "go.mod"
+
+      - name: Verify Homebrew is installed
+        run: |
+          echo "Homebrew version:"
+          brew --version
+
+      - name: Install GoReleaser
+        run: brew install goreleaser
+
+      - name: Make test script executable
+        run: chmod +x test-scripts/test-homebrew-build.sh
+
+      - name: Run build validation
+        run: ./test-scripts/test-homebrew-build.sh
+
+      - name: Run installation tests
+        run: ./test-scripts/test-homebrew-build.sh --install
+
+      # Upload generated Homebrew formula (cask distribution has been disabled)
+      - name: Upload generated Homebrew files
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: homebrew-files
+          path: |
+            dist/homebrew/Formula/hookdeck.rb
+          retention-days: 7

.gitignore

@@ -1,4 +1,5 @@
 
+completions/
 dist/
 bin/
 coverage.txt

.goreleaser/mac.yml

@@ -5,6 +5,7 @@ before:
   hooks:
     - go mod download
     - go generate ./...
+    - ./scripts/completions.sh
 project_name: hookdeck
 builds:
   - id: hookdeck-darwin
@@ -37,29 +38,64 @@ checksum:
   name_template: "{{ .ProjectName }}-checksums.txt"
 snapshot:
   name_template: "{{ .Tag }}-next"
-homebrew_casks:
+archives:
+  - id: hookdeck
+    files:
+      - completions/*
+      - LICENSE*
+      - README*
+      - CHANGELOG*
+brews:
   - name: hookdeck
+    ids:
+      - hookdeck
     repository:
       owner: hookdeck
       name: homebrew-hookdeck
-    commit_author:
-      name: hookdeck
-      email: [email protected]
+    directory: Formula
     homepage: https://hookdeck.com
-    description: Hookdeck CLI utility
-    caveats: "❤ Thanks for installing the Hookdeck CLI! If this is your first time using the CLI, be sure to run `hookdeck login` first."
-    custom_block: |
-      postflight do
-        system "hookdeck", "completion", "--shell", "bash"
-        system "hookdeck", "completion", "--shell", "zsh"
-        bash_completion.install "hookdeck-completion.bash"
-        zsh_completion.install "hookdeck-completion.zsh"
-        (zsh_completion/"_hookdeck").write <<~EOS
-          #compdef hookdeck
-          _hookdeck () {
-            local e
-            e=$(dirname ${funcsourcetrace[1]%:*})/hookdeck-completion.zsh
-            if [[ -f $e ]]; then source $e; fi
-          }
-        EOS
-      end
+    description: Receive events (e.g. webhooks) on your localhost with event history, replay, and team collaboration
+    
+    install: |
+      bin.install "hookdeck"
+      
+      # Install completions from pre-generated files
+      bash_completion.install "completions/hookdeck.bash" => "hookdeck"
+      zsh_completion.install "completions/_hookdeck"
+    
+    caveats: |
+      ❤ Thanks for installing the Hookdeck CLI!
+      
+      If this is your first time using the CLI, run:
+        hookdeck login
+
+# TODO: Temporarily disabled until we implement code signing
+# Cask distribution causes Gatekeeper issues with unsigned binaries
+# Will re-enable once Apple Developer certificate is in place
+#
+# homebrew_casks:
+#   - name: hookdeck
+#     ids:
+#       - hookdeck
+#     repository:
+#       owner: hookdeck
+#       name: homebrew-hookdeck
+#     homepage: https://hookdeck.com
+#     description: Receive events (e.g. webhooks) on your localhost with event history, replay, and team collaboration
+#     # Install shell completions automatically
+#     completions:
+#       bash: "completions/hookdeck.bash"
+#       zsh: "completions/_hookdeck"
+#
+#     caveats: |-
+#       Thanks for installing the Hookdeck CLI!
+#
+#       ⚠️  If you see an error about a binary already existing:
+#         brew uninstall hookdeck
+#         brew install --cask hookdeck/hookdeck/hookdeck
+#
+#       Shell completions have been installed automatically.
+#       You may need to restart your shell for them to take effect.
+#
+#       First time using the CLI? Run:
+#         hookdeck login

README.md

@@ -430,6 +430,24 @@ There are also some hidden flags that are mainly used for development and debugg
 *   `--console-base`: Sets the web console base URL.
 *   `--ws-base`: Sets the Websocket base URL.
 
+## Troubleshooting
+
+### Homebrew: Binary Already Exists Error
+
+If you previously installed Hookdeck via the Homebrew formula and are upgrading to the cask version, you may see:
+
+```
+Warning: It seems there is already a Binary at '/opt/homebrew/bin/hookdeck'
+from formula hookdeck; skipping link.
+```
+
+To resolve this, uninstall the old formula version first, then install the cask:
+
+```sh
+brew uninstall hookdeck
+brew install --cask hookdeck/hookdeck/hookdeck
+```
+
 
 ## Developing
 

scripts/completions.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+set -e
+
+# Generate shell completions for Hookdeck CLI
+# This script is run during the GoReleaser build process to pre-generate
+# completion files that will be included in the release archives.
+
+rm -rf completions
+mkdir completions
+
+# Use 'go run .' to compile and run the CLI to generate completions
+# This works on any platform that can build Go code
+# The completion command writes files to the current directory, so we cd into completions/
+echo "Generating bash completion..."
+(cd completions && go run .. completion --shell bash)
+
+echo "Generating zsh completion..."
+(cd completions && go run .. completion --shell zsh)
+
+# Rename the generated files to match GoReleaser expectations
+mv completions/hookdeck-completion.bash completions/hookdeck.bash
+mv completions/hookdeck-completion.zsh completions/_hookdeck
+
+# Fish completion is not currently supported by the CLI
+# If it gets added in the future, uncomment this:
+# echo "Generating fish completion..."
+# go run . completion --shell fish > completions/hookdeck.fish
+
+echo "✅ Completions generated successfully in completions/"
+ls -lh completions/