複数ふくすうのGoツールをひとつのhomebrewリポジトリで配布はいふする

Goで書かかれたCLIツールを homebrew で配布はいふするために goreleaser@goreleaser-action がよく使つかわれている。よくある解説かいせつでは、ひとつのCLIに対たいしてひとつの homebrew リポジトリを作成さくせいして Formula を配布はいふするかたちになっていることが多おおいが、複数ふくすうの CLI tool を配布はいふするとなったとき、毎回まいかいツール自体じたいのリポジトリとセットで homebrew 用ようのリポジトリを作成さくせいするのはちょっと面倒めんどうくさい。

aws や hashicorp がひとつの homebrew用ようリポジトリにある Formula ディレクトリに複数ふくすうツールの配布はいふ用ようデータセットを置おいているのを見みつけたので、構成こうせいをマネして goreleaser の設定せっていを書かいてみた。

なお、githubの公開こうかいリポジトリで野良のら配布はいふする前提ぜんていで、goreleaserで単発たんぱつ配布はいふまではできているとします。

homebrew用ようリポジトリ

取とり急いそぎ、Formula を置おくリポジトリをつくる。たぶん任意にんいの名前なまえで良よいが、 aws や hashicorp にならって homebrew-tap とする。わかりやすい。

私わたしのを参考さんこうまでに：bayashi/homebrew-tap

GITHUB Personal access tokens

まず、複数ふくすうCLIをまとめることには関係かんけいないが、homebrew向むけのワークフロー設定せっていに必要ひつようなので、githubアカウントで Personal access token を発行はっこうしておく。repo権限けんげんがあればOK。これはリポジトリごとに発行はっこうしてもいいし、ひとつのトークンを使つかいまわしても良よいと思おもう。なぜなら同おなじリポジトリを変更へんこうするための token だから(ひとつひとつのツールをセキュアにするなら個別こべつ発行はっこうの方ほうが望のぞましいとは思おもいますが)。

発行はっこうした token は、CLI ツールのリポジトリの Actions secrets メニューで HOMEBREW_TAP_GITHUB_TOKEN という名前なまえで secrets に登録とうろくしておく。この名前なまえは任意にんいです。後述こうじゅつする goreleaser の設定せっていファイル .yaml の中なかで指定していします。

goreleaser

releaser.yaml

まず、.github/workflows/releaser.yaml に上うえで発行はっこうした HOMEBREW_TAP_GITHUB_TOKEN の指定していを追加ついかしておきます(最終さいしゅう行ぎょう)。

name: releaser

on:
  push:
    tags:
      - v*
jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: 1.19
      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v4
        with:
          version: latest
          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}

workflow 自体じたいのファイル名めいは任意にんいです。

.goreleaser.yaml

つづいて、プロジェクト直下ちょっかに配置はいちする .goreleaser.yaml には、brew 向むけに以下いかのような項目こうもくを書かいておきます。irir というツールの例れいです。

brews:
  - tap:
      owner: bayashi
      name: homebrew-tap
      token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
    folder: Formula
    homepage: https://github.com/bayashi/irir
    description: A filter to add colors for text lines generically from a YAML configuration file easily
    test: |
      system "#{bin}/irir", '--version'

抽象ちゅうしょう化かした解説かいせつを書かいておくと、

brews:
  - tap:
      owner: {あなたのgithubアカウント}
      name: {homebrew用ようリポジトリ名めい}
      token: "{{ .Env.CLIツールのリポジトリでsecretsに登録とうろくしたtokenの名前なまえ }}"
    folder: {homebrew用ようリポジトリでのディレクトリ名めい。特とくに変更へんこうする必要ひつようもないので Formula のまま}
    homepage: {CLIツールを紹介しょうかいするページURL}
    description: {CLIツールの紹介しょうかい文ぶん}
    test: |
      system "#{bin}/{CLIツールコマンド}", '{必要ひつようならオプション}' # テスト発行はっこうするコマンド

brews.tap.name のところを {homebrew用ようリポジトリ名めい} として、今回こんかいは homebrew-tap と指定していしている。HOMEBREW_TAP_GITHUB_TOKEN は上うえで発行はっこうしたもの。

Workflow permissions

この設定せっていは 複数ふくすうCLI配布はいふするためというわけではないが、goreleaser を github で動うごかすために必要ひつような設定せってい。

CLIのリポジトリの settings タブにある、Actions.General のメニューの中なかに Workflow permissions というのがあるので、これを read and write permissions に変更へんこうして保存ほぞんする。

これをしておかないと、goreleaser のワークフローが 403 でこける。

homebrew 配布はいふコマンド

goreleaser が無事ぶじ走はしり切きると、homebrew-tap/Formula 以下いかに {ツール名めい}.rb が生成せいせいされていると思おもいます。

配布はいふ用ようのコマンドは以下いかのようになります。

brew tap {あなたのgithubアカウント}/tap
brew install {あなたのgithubアカウント}/tap/{ツール名めい}

例たとえば、bayashi の irir というツールの場合ばあい、

brew tap bayashi/tap
brew install bayashi/tap/irir

となります。

まとめ

リポジトリを毎回まいかい作つくる手間てまが省はぶけてハッピー