コンテンツへスキップ

GitHub ActionsでElixirを高速化する

最終更新

ElixirをGitHub Actionsで高速化するには、erlef/setup-beamでErlangとElixirをインストールし、mix.lockとOTP・Elixirのバージョンから作成したキーでdepsと_buildをキャッシュし、mix test --partitionsでテストを分割します。Elixirのコンパイルは高速ですが、キャッシュのないビルドではC言語ベースのbcrypt_elixirなどを含むすべての依存関係をコンパイルするため、時間の大半がここで失われます。

このガイドでは、Phoenixの完全なワークフローを紹介します。全般的なアプローチについては、GitHub Actionsを高速化する方法をご覧ください。

ErlangとElixirのインストール

erlef/setup-beamはコミュニティで標準的に使われているアクションです。READMEによると、otp-versionとelixir-versionを文字列で指定するか、version-fileを使って.tool-versionsファイルを読み込ませることができます(.tomlで終わるファイルはmiseの設定として解析されます)。バージョンファイルを使う場合、READMEではversion-typeをstrictにする必要があるとされています。バージョンファイルとYAMLの入力を併用しないでください。併用するとアクションはエラーで終了します。アクションのREADMEでは、固定したい場合はv1.8.0のような正確なタグを使うこともできますが、通常は移動するv1タグの使用が推奨されています。

- uses: actions/checkout@v7
- uses: erlef/setup-beam@v1
  id: beam
  with:
    otp-version: "27"
    elixir-version: "1.18"

READMEでは、otp-versionとelixir-versionが出力として挙げられており、インストールされた正確なバージョンが格納されます。これをキャッシュキーで使用してください。

depsと_buildのキャッシュ

READMEにはキャッシュの手順は含まれていないため、自分で構成する必要があります。重要なフォルダは2つあります。deps(取得済みの依存関係)と_build(コンパイル済みの出力)です。_buildはOTPのバージョン間で移植できないため、ロックファイルまたはいずれかのランタイムバージョンが変わるたびにキーも変わる必要があります。

- uses: actions/cache@v6
  with:
    path: |
      deps
      _build
    key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
    restore-keys: |
      mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- run: mix deps.get
- run: mix compile --warnings-as-errors

restore-keysのフォールバックにより、mix.lockが変更されても前回の_buildから開始でき、Mixは変更された依存関係だけを再コンパイルします。キャッシュの復元後にmix deps.getを実行しても問題なく、不足分だけを取得するため高速です。MIX_ENVは一貫させてください。_build/testと_build/devは別々のフォルダであり、CIではtestのみをコンパイルするべきです。

env:
  MIX_ENV: test

キャッシュのエントリは変更不可で、サイズと保存期間に制限があります。詳しくはGitHub Actionsのキャッシュの制限をご覧ください。_buildが時間の経過とともに大きくなった場合は、キーにバージョン接頭辞(mix-v2-)を含めておくと、必要に応じてリセットできます。

Postgresサービスの利用

Ectoを使うPhoenixアプリにはデータベースが必要です。ヘルスチェック付きのサービスを追加してください。

services:
  postgres:
    image: postgres:17
    env:
      POSTGRES_PASSWORD: postgres
    ports: ["5432:5432"]
    options: >-
      --health-cmd "pg_isready -U postgres"
      --health-interval 5s --health-timeout 5s --health-retries 10

config/test.exsの接続先をlocalhostに設定し、ホストは環境変数から読み込むようにすると、ローカルでもCIでも動作します。EctoのSQLサンドボックスにより、テストは各自のトランザクション内で並行実行できるため、テスト同士がグローバルな状態を共有しない箇所ではuse MyApp.DataCase, async: trueを使用してください。

テストの分割:並行実行とパーティション

Elixirのテスト並列化には2つの階層があります。

1台のマシン内:ExUnitはasync: trueのテストモジュールを並行して実行します。デフォルトのmax_casesはスケジューラー数の2倍なので、コア数が多いほど同時に実行されるテストも増えます。可能な限り多くのモジュールをasync: trueに変更してください。ファイルシステム、名前付きプロセス、グローバル設定、Application.put_envに触れるテストは、同期的なままにしておくべきです。

複数のマシンにまたがる場合:mix test --partitions NはテストファイルをN個のパーティションに分割し、MIX_TEST_PARTITION環境変数で選ばれた1つを実行します。マトリクスを使用してください。

strategy:
  fail-fast: false
  matrix:
    partition: [1, 2, 3, 4]
steps:
  # ...checkout, setup-beam, cache, deps...
  - run: mix test --partitions 4
    env:
      MIX_TEST_PARTITION: ${{ matrix.partition }}

パーティションを使う場合、Ectoのドキュメントではデータベース名にパーティション番号を含めることを推奨しており、これによりジョブごとにデータベースが分離されます。config/test.exsでdatabase: "myapp_test#{System.get_env("MIX_TEST_PARTITION")}"と指定します。これは、同じマシン上で複数のパーティションを実行するなど、パーティションが1つのデータベースサーバーを共有する場合に必要です。サービスコンテナが別々のジョブでは、この設定は害はありませんが必須ではありません。GitHub Actionsでのテストシャーディングとテストシャード計算ツールもご覧ください。

リント、フォーマット、Dialyzerを別々のジョブで実行

  • mix format --check-formattedはコンパイルを必要としないため、最初に実行してください。失敗するのも早く分かります。
  • mix credo --strictは高速です。
  • Dialyzer(Dialyxir経由)は、ErlangとElixirのモジュールのPLT(永続的な検索テーブル)を構築するため低速です。PLTのフォルダ(例:priv/plts)を、OTPのバージョン、Elixirのバージョン、mix.lockをキーにしてキャッシュしてください。PLTがウォーム状態であれば、10分かかる実行が短時間で終わります。テストをブロックしないよう、独立したジョブで実行してください。

リリースとDocker

リリースイメージをビルドする場合は、アプリのコードより前のDockerレイヤーで依存関係をコンパイルし、BuildKitのキャッシュを使用してください。詳しくはCIでのDockerレイヤーキャッシュをご覧ください。

CPU コア数を増やす効果

BEAMはテストを並行実行するためにすべてのコアを使用し、mix compileはファイルを並列にコンパイルします。当社のベンチマークにはPhoenix LiveView + Postgresが含まれており、GitHub提供のランナーでは2m07s、compiler.dev では1m03s(2.0x)でした。テストシャードを10個、実際のデータベースを使用した完全なCI実行で、2026年10月8日に計測しています。max_casesはマシンの性能に応じて拡張されるため、非同期処理の多いテストスイートほど大きな効果が得られます。

お使いのプロジェクトで試すには、1行をruns-on: [self-hosted, Linux, compiler-ci]に変更してください。料金と比較もご覧ください。関連情報として、ElixirのテンプレートとGitHub Actionsのキャッシュもあります。

よくある質問

Elixirのキャッシュキーには何を含めるべきですか?

ランナーのOS、OTPのバージョン、Elixirのバージョン、mix.lockのハッシュです。_buildはOTPのバージョン間での再利用は安全ではありません。

mix test --partitionsはEctoで動作しますか?

はい。パーティションがデータベースサーバーを共有する場合は、MIX_TEST_PARTITION変数を使って、パーティションごとにデータベース名を一意にしてください。

_buildとdepsのどちらをキャッシュすべきですか?

両方です。depsだけをキャッシュするとダウンロードは省けますが、_buildをキャッシュするとコンパイル時間を省けます。通常はコンパイル時間のほうが長くかかります。

CIでDialyzerを高速化するにはどうすればよいですか?

OTPのバージョン、Elixirのバージョン、mix.lockをキーにしてPLTのディレクトリをキャッシュし、独立したジョブとして実行してください。

このワークフローを compiler.dev で実行する カード登録不要 · 200 無料分

無料で試す