2022-04-12

Homebrew を dotfiles で管理する際にやったこと

はじめに

満を持して dotfiles¹ を作り始めた。プロダクティビティや自動化といった話が大好きで、やりだしたら時間の許す限り趣向を凝らしたものを作りたくなるので沼だ。

僕が今メインで使用しているマシンは Macbook Pro なので、まずは macOS 用の環境を作っていこうと思った。そして、macOS 用のパッケージマネージャである Homebrew² の管理から始めたのでその際に学んだことや考えたことをまとめる。

Homebrew の周辺知識

基本的なことは省くが dotfiles を作るにあたり知っておくと良いことを書く。

Homebrew Bundle

Homebrew Bundle とは、Brewfile というファイルに設定をまとめておくと brew bundle コマンドを使って一発で Homebrew の環境構築ができるという仕組み。しかも後述する Homebrew Cask や Mac App Store（以下 MAS）にも対応している。

GitHub - Homebrew/homebrew-bundle: 💀 Homebrew Bundle (deprecated)

💀 Homebrew Bundle (deprecated). Contribute to Homebrew/homebrew-bundle development by creating an account on GitHub.

github.com

GitHub - Homebrew/homebrew-bundle: 💀 Homebrew Bundle (deprecated)

つまり dotfiles で Brewfile を管理することで Homebrew で管理しているソフトウェア（及び MAS からインストールしているアプリケーション）の一括インストールが可能になる。

これまで Homebrew を使用していてかつこれから dotfiles を作り始める方は brew bundle dump コマンドを使うとカレントディレクトリに Brewfile が生成されるはずだ。

# 初めて使う場合は適当に何かインストール
$ brew install jq

# Brewfile に出力
$ brew bundle dump

# インストールしたソフトウェアが羅列されていれば OK
$ cat Brewfile
brew "jq"

Homebrew Cask

Homebrew Cask とは GUI を持つアプリケーションを CLI でインストールできる仕組みだ。

GitHub - Homebrew/homebrew-cask: 🍻 A CLI workflow for the administration of macOS applications distributed as binaries

🍻 A CLI workflow for the administration of macOS applications distributed as binaries - Homebrew/homebrew-cask

github.com

GitHub - Homebrew/homebrew-cask: 🍻 A CLI workflow for the administration of macOS applications distributed as binaries

僕は GUI アプリだろうと基本的に Homebrew で管理するようにしている。公式の GitHub にも書いてあるとおり CLI だとスピーディに導入できるので本当におすすめ。

# cask オプションを付けてインストール
$ brew install --cask alfred

$ brew bundle dump

$ cat Brewfile
brew "jq"
cask "alfred"

Mac App Store

App Store からインストールするアプリも Brewfile で管理する。

# MAS CLI を導入
$ brew install mas

# インストールしたいアプリケーションを調べる
$ mas search Twitter | hean -n1
  1482454543  Twitter                                                     (9.4.1)

# id を使ってインストール
$ mas install 1482454543

$ brew bundle dump

$ cat Brewfile
brew "jq"
cask "alfred"
mas "Twitter", id: 1482454543

ちなみに MAS CLI を使う場合は事前に App Store へログインしておく必要がある。

インストールスクリプトを書く

これで、Brewfile ができたので、インストールを実行する bash スクリプトを書いていく。

先に全体を貼り付けておく。

#!/bin/bash -eux

echo "Start setup ..."

if [ $(uname) = Darwin ]; then
    if ! type brew &> /dev/null ; then
        /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    else
        echo "Since Homebrew is already installed, skip this phase and proceed."
    fi
    brew bundle install --file=Brewfile
fi

簡単に中身について説明すると…

uname で OS が Darwin つまり macOS の場合には処理に進む。
type でコマンドが使用できるか確認し、Homebrew が使えなかったら Homebrew をインストールする。
最後に Brewfile を元にソフトウェアを一括でインストールする。

ゆくゆくは macOS 以外でも使用できるようにしたいので、エントリーポイントとなるスクリプトについては OS で分岐させるようにした。

GitHub Actions で CI を回す

さて、ここまでやってみたはいいがどうやってテストしようと悩んだ末 GitHub Actions の macOS ランナーを使うことにした。

.github/workflows/ ディレクトリに以下のような YAML ファイルを作った。使用できる環境はこちらを参照して欲しい。

.github/workflows/build.yaml

name: 'build'

on:
  pull_request:
    branches:
    - main
  workflow_dispatch:

jobs:
  build:
    name: Build
    runs-on: macos-latest   # <--- macOS Big Sur 11

    steps:
    - name: Checkout
      uses: actions/checkout@v3

    - name: Execute install script
      run: |
        MAS_APPS="$(cat Brewfile | grep -v brew | grep mas | sed 's/^.*"\(.*\)".*$/\1/' | tr '\n' ' ')"
        export HOMEBREW_BUNDLE_MAS_SKIP="$MAS_APPS"
        export HOMEBREW_BUNDLE_BREW_SKIP="awscli go"
        ./install.sh

install.sh が実行できるかを確認するだけで良いのだが、GitHub Actions の macOS ランナーでは既に Homebrew や awscli など既にセットアップされている。そのため、HOMEBREW_BUNDLE_BREW_SKIP , HOMEBREW_BUNDLE_MAS_SKIP を環境変数に設定してインストールをスキップするように細工した。