feat: Update release workflow and enhance package manager setup documentation

Author: dataGriff

.github/workflows/release.yml

@@ -11,12 +11,13 @@ on:
         required: true
         default: 'v0.1.0'
 
+permissions:
+  contents: write
+  packages: write
+
 jobs:
-  release:
+  goreleaser:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      packages: write
 
     steps:
     - name: Checkout
@@ -39,70 +40,20 @@ jobs:
     - name: Run linting
       run: task lint
 
-    - name: Build all platforms
-      run: task build:all
-
-    - name: Package binaries
-      run: task package
-
-    - name: Generate checksums
-      run: |
-        cd bin/releases
-        sha256sum * > checksums.txt
-
-    - name: Create Release
-      uses: softprops/action-gh-release@v1
-      with:
-        files: |
-          bin/releases/codebase-interface-linux-amd64.tar.gz
-          bin/releases/codebase-interface-darwin-amd64.tar.gz
-          bin/releases/codebase-interface-darwin-arm64.tar.gz
-          bin/releases/codebase-interface-windows-amd64.zip
-          bin/releases/codebase-interface-linux-amd64
-          bin/releases/codebase-interface-darwin-amd64
-          bin/releases/codebase-interface-darwin-arm64
-          bin/releases/codebase-interface-windows-amd64.exe
-          bin/releases/checksums.txt
-        generate_release_notes: true
-        draft: false
-        prerelease: false
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  docker:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
-
     - name: Log in to GitHub Container Registry
       uses: docker/login-action@v3
       with:
         registry: ghcr.io
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Extract metadata
-      id: meta
-      uses: docker/metadata-action@v5
-      with:
-        images: ghcr.io/${{ github.repository }}
-        tags: |
-          type=ref,event=tag
-          type=raw,value=latest,enable={{is_default_branch}}
-
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v5
+    - name: Run GoReleaser
+      uses: goreleaser/goreleaser-action@v5
       with:
-        context: .
-        platforms: linux/amd64,linux/arm64
-        push: true
-        tags: ${{ steps.meta.outputs.tags }}
-        labels: ${{ steps.meta.outputs.labels }}
+        distribution: goreleaser
+        version: latest
+        args: release --clean
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
+        CHOCOLATEY_API_KEY: ${{ secrets.CHOCOLATEY_API_KEY }}

.goreleaser.yaml

@@ -51,9 +51,6 @@ archives:
 checksum:
   name_template: 'checksums.txt'
 
-snapshot:
-  name_template: "{{ incpatch .Version }}-next"
-
 changelog:
   sort: asc
   use: github
@@ -83,6 +80,8 @@ brews:
     repository:
       owner: codebase-interface
       name: homebrew-cli
+      branch: main
+      token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
     commit_author:
       name: goreleaserbot
       email: [email protected]
@@ -94,6 +93,7 @@ brews:
       bin.install_symlink bin/"codebase-interface" => "cbi"
     test: |
       system "#{bin}/codebase-interface", "version"
+      system "#{bin}/cbi", "version"
 
 # Chocolatey package for Windows
 chocolateys:
@@ -106,14 +106,24 @@ chocolateys:
     license_url: https://github.com/codebase-interface/cli/blob/main/LICENSE
     require_license_acceptance: false
     project_source_url: https://github.com/codebase-interface/cli
-    docs_url: https://github.com/codebase-interface/cli/blob/main/README.md
+    docs_url: https://cli.codebaseinterface.org
     bug_tracker_url: https://github.com/codebase-interface/cli/issues
     tags: "cli development validation codebase"
     summary: A CLI tool for validating codebase structure and development standards
     description: |
       Codebase Interface CLI validates essential files and configurations for proper codebase setup.
       It checks for README.md, CONTRIBUTING.md, Git configuration files, and development standards.
+      
+      Features:
+      - Essential files validation (README, CONTRIBUTING, docs/)
+      - Git configuration validation (.gitignore, .editorconfig, .gitattributes)
+      - Development standards validation (conventional commits, branch naming)
+      - JSON Schema-based configuration validation
+      - Multiple output formats (table, JSON)
+      - Configuration presets for quick setup
+      - Cross-platform support (Windows, macOS, Linux)
     release_notes: "https://github.com/codebase-interface/cli/releases/tag/v{{ .Version }}"
+    api_key: "{{ .Env.CHOCOLATEY_API_KEY }}"
 
 # Docker images
 dockers:

README.md

@@ -29,6 +29,8 @@ Invoke-WebRequest -Uri "https://github.com/codebase-interface/cli/releases/lates
 
 ### 📦 Package Managers
 
+> **Note**: Package manager distribution requires setup of Homebrew tap and Chocolatey API keys. See [Package Manager Setup Guide](docs/package-manager-setup.md) for maintainer instructions.
+
 **Homebrew (macOS/Linux):**
 ```bash
 brew tap codebase-interface/cli

docs/package-manager-setup.md

@@ -0,0 +1,172 @@
+# Package Manager Setup Guide
+
+This guide explains how to set up the automated package publishing for Homebrew and Chocolatey.
+
+## 🍺 Homebrew Setup
+
+### 1. Create Homebrew Tap Repository
+
+First, you need to create a separate repository for the Homebrew tap:
+
+```bash
+# Create a new repository named 'homebrew-cli'
+# This should be done through GitHub UI or API
+# Repository should be: codebase-interface/homebrew-cli
+```
+
+The repository structure will look like:
+```
+homebrew-cli/
+└── Formula/
+    └── codebase-interface.rb
+```
+
+### 2. Set Up GitHub Token
+
+Create a GitHub token with repository access:
+
+1. Go to GitHub Settings → Developer settings → Personal access tokens
+2. Generate a new token (classic) with `repo` permissions
+3. Add it as a repository secret named `HOMEBREW_TAP_GITHUB_TOKEN`
+
+### 3. How It Works
+
+When you create a release:
+
+1. **GoReleaser** automatically creates a Homebrew formula
+2. **Formula** gets pushed to `codebase-interface/homebrew-cli` 
+3. **Users** can then install with:
+   ```bash
+   brew tap codebase-interface/cli
+   brew install codebase-interface
+   ```
+
+The formula will be generated automatically and look like:
+```ruby
+class CodebaseInterface < Formula
+  desc "A CLI tool for validating codebase structure and development standards"
+  homepage "https://github.com/codebase-interface/cli"
+  url "https://github.com/codebase-interface/cli/releases/download/v1.0.0/codebase-interface-Darwin-x86_64.tar.gz"
+  sha256 "..."
+  license "MIT"
+
+  def install
+    bin.install "codebase-interface"
+    bin.install_symlink bin/"codebase-interface" => "cbi"
+  end
+
+  test do
+    system "#{bin}/codebase-interface", "version"
+    system "#{bin}/cbi", "version"
+  end
+end
+```
+
+## 🍫 Chocolatey Setup
+
+### 1. Create Chocolatey Account
+
+1. Create account at [chocolatey.org](https://chocolatey.org/)
+2. Get your API key from your account profile
+3. Add it as a repository secret named `CHOCOLATEY_API_KEY`
+
+### 2. How It Works
+
+When you create a release:
+
+1. **GoReleaser** creates a Chocolatey package (.nupkg)
+2. **Package** gets automatically uploaded to Chocolatey repository
+3. **Users** can then install with:
+   ```powershell
+   choco install codebase-interface
+   ```
+
+The package will include:
+- Windows executable
+- PowerShell install/uninstall scripts
+- Automatic PATH configuration
+- Both `codebase-interface.exe` and `cbi.exe` commands
+
+## 🔧 Required Repository Secrets
+
+Add these secrets to your GitHub repository:
+
+```bash
+# For Homebrew tap publishing
+HOMEBREW_TAP_GITHUB_TOKEN=github_pat_...
+
+# For Chocolatey package publishing  
+CHOCOLATEY_API_KEY=...
+
+# Already configured for GitHub releases
+GITHUB_TOKEN=... (automatic)
+```
+
+## 🎯 Testing Package Managers
+
+### Test Homebrew Locally
+
+```bash
+# Install from your tap
+brew tap codebase-interface/cli
+brew install codebase-interface
+
+# Verify installation
+codebase-interface version
+cbi version
+
+# Test upgrade path
+brew upgrade codebase-interface
+```
+
+### Test Chocolatey Locally
+
+```powershell
+# Install from Chocolatey
+choco install codebase-interface
+
+# Verify installation  
+codebase-interface version
+cbi version
+
+# Test upgrade path
+choco upgrade codebase-interface
+```
+
+## 📋 Release Checklist
+
+Before releasing with package manager support:
+
+- [ ] Create `codebase-interface/homebrew-cli` repository
+- [ ] Add `HOMEBREW_TAP_GITHUB_TOKEN` secret 
+- [ ] Add `CHOCOLATEY_API_KEY` secret
+- [ ] Test GoReleaser configuration locally:
+  ```bash
+  goreleaser check
+  goreleaser release --snapshot --clean
+  ```
+- [ ] Create a test release with a pre-release tag
+- [ ] Verify packages are published correctly
+
+## 🚀 First Release
+
+For your first release with package managers:
+
+1. **Create the required repositories and secrets**
+2. **Tag your release:**
+   ```bash
+   git tag v1.0.0
+   git push --tags
+   ```
+3. **Monitor the GitHub Action** to ensure all steps complete
+4. **Test installation** from both package managers
+5. **Update documentation** with installation instructions
+
+The release process will:
+- ✅ Build binaries for all platforms  
+- ✅ Create GitHub release with assets
+- ✅ Publish Docker images to GHCR
+- ✅ Create Homebrew formula in tap repository
+- ✅ Publish Chocolatey package to chocolatey.org
+
+After the first successful release, users will be able to install your CLI using standard package managers!

mkdocs.yml

@@ -44,6 +44,8 @@ nav:
     - Go Project: examples/go-project.yml
     - Open Source: examples/open-source.yml
     - Strict Standards: examples/strict.yml
+  - Development:
+    - Package Manager Setup: package-manager-setup.md
 
 plugins:
   - search