ci: publish to homebrew tap (#42)

twelvelabs · Apr 20, 2023 · e916eaa · e916eaa
1 parent ebfd6cb
commit e916eaa
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -86,3 +86,4 @@ jobs:
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.GH_PAT }}
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -18,6 +18,19 @@ archives:
   - id: stylist
     format: binary
 
+brews:
+  - name: stylist
+    tap:
+      owner: twelvelabs
+      name: homebrew-tools
+      branch: main
+      token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
+    folder: Formula
+
+    homepage: "https://github.com/twelvelabs/stylist"
+    description: "Manage all your code quality tools with a single executable."
+    license: "MIT"
+
 checksum:
   name_template: "checksums.txt"
   algorithm: sha256

diff --git a/README.md b/README.md
@@ -71,3 +71,25 @@ $ stylist check
 $ stylist fix
 [markdownlint] README.md
 ```
+
+## Installation
+
+### Using [Homebrew](https://brew.sh/)
+
+```bash
+brew install twelvelabs/tools/stylist
+```
+
+### Pre-built binary
+
+Download a pre-built binary from the
+[Releases](https://github.com/twelvelabs/stylist/releases) page.
+
+### From source
+
+```bash
+go install "github.com/twelvelabs/stylist@latest"
+# or a specific version tag
+tag=$(gh release view --json tagName --jq .tagName)
+go install "github.com/twelvelabs/stylist@${tag}"
+```