Merge pull request #371 from joshrotenberg/feat/homebrew-auto-update

feat: add automatic Homebrew formula updates on release

Author: joshrotenberg

.github/workflows/release.yml

@@ -42,7 +42,7 @@ on:
   pull_request:
   push:
     tags:
-      - '**[0-9]+.[0-9]+.[0-9]+*'
+      - "**[0-9]+.[0-9]+.[0-9]+*"
 
 jobs:
   # Run 'dist plan' (or host) to determine what tasks we need to do
@@ -278,6 +278,22 @@ jobs:
 
           gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/*
 
+  update_brew_formula:
+    name: Update Brew Formula
+    runs-on: ubuntu-latest
+    needs: [plan, host]
+    if: ${{ needs.plan.outputs.publishing == 'true' }}
+    steps:
+      - uses: mislav/[email protected]
+        with:
+          formula-name: redisctl
+          formula-path: Formula/redisctl.rb
+          base-branch: main
+          tag-name: ${{ github.ref_name }}
+          homebrew-tap: joshrotenberg/homebrew-brew
+        env:
+          COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}
+
   announce:
     needs:
       - plan

Cargo.toml

@@ -39,6 +39,8 @@ create-release = true
 install-path = "CARGO_HOME"
 # Whether to install an updater program
 install-updater = false
+# Allow custom modifications to generated CI files
+allow-dirty = ["ci"]
 
 [workspace.dependencies]
 # Core dependencies

README.md

@@ -17,6 +17,11 @@ A unified command-line interface for managing Redis Cloud and Redis Enterprise d
 
 ## Installation
 
+### Homebrew (macOS/Linux)
+```bash
+brew install joshrotenberg/brew/redisctl
+```
+
 ### From Binary Releases
 Download the latest release for your platform from the [releases page](https://github.com/joshrotenberg/redisctl/releases).
 

docs/src/getting-started/installation.md

@@ -1,5 +1,28 @@
 # Installation
 
+## Homebrew (macOS/Linux)
+
+The easiest way to install on macOS or Linux:
+
+```bash
+# Install directly (automatically taps the repository)
+brew install joshrotenberg/brew/redisctl
+
+# Or tap first, then install
+brew tap joshrotenberg/brew
+brew install redisctl
+```
+
+This will:
+- Install the latest stable version
+- Set up the binary in your PATH
+- Enable automatic updates via `brew upgrade`
+
+To upgrade to the latest version:
+```bash
+brew upgrade redisctl
+```
+
 ## Binary Releases
 
 Download the latest release for your platform from the [GitHub releases page](https://github.com/joshrotenberg/redisctl/releases).

docs/src/introduction.md

@@ -17,6 +17,16 @@ The CLI provides three layers of interaction:
 2. **Human-Friendly Commands** - Typed wrappers around common operations  
 3. **Workflows** - Multi-step orchestrated operations (coming soon)
 
+## Installation
+
+Get started quickly with Homebrew:
+
+```bash
+brew install joshrotenberg/brew/redisctl
+```
+
+Or see [Installation](./getting-started/installation.md) for other methods.
+
 ## Quick Example
 
 ```bash