コンテンツへスキップ

Elixir GitHub Actions ワークフローテンプレート

最終更新

これは、Postgresを使うElixirまたはPhoenixアプリ向けの動作する.github/workflows/ci.ymlです。erlef/setup-beamでErlang/OTPとElixirをインストールし、depsと_buildをキャッシュし、フォーマットをチェックし、警告をエラーとしてコンパイルし、mix testを実行します。

ワークフロー

name: CI

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

concurrency:
  group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  test:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    services:
      postgres:
        image: postgres:16
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
        ports:
          - 5432:5432
        options: >-
          --health-cmd "pg_isready -U postgres"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 10
    env:
      MIX_ENV: test
      DATABASE_URL: ecto://postgres:postgres@localhost:5432/app_test
    steps:
      - uses: actions/checkout@v4

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

      - uses: actions/cache@v4
        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 format --check-formatted
      - run: mix compile --warnings-as-errors
      - run: mix ecto.create && mix ecto.migrate
      - run: mix test

分かりにくい部分の役割

  • erlef/setup-beam@v1は、Erlang/OTPとElixirをインストールします。両方のバージョンは引用符付きの文字列で固定してください。そうしないとYAMLが数値として解釈してしまいます。このアクションは、インストールした正確なバージョンを出力します。キャッシュキーはid: beamを通じてこの値を使用します。
  • OTPとElixirのバージョンを含むキャッシュキー。コンパイル済みの_buildの出力は、それを生成したバージョンでのみ有効です。バージョンを含めることで、異なるバージョンのbeamファイルを読み込むことを防げます。mix.lockが変更されると新しいキャッシュが作成され、restore-keysは同じバージョンの最新のキャッシュにフォールバックします。
  • depsと_buildを両方キャッシュします。depsはダウンロードされたパッケージを保持し、_buildは依存関係を含むコンパイル済みの出力を保持します。両方をキャッシュすることで、以降の実行が高速になります。依存関係のコンパイルは、キャッシュがない状態での実行において最も時間のかかる部分です。GitHub ActionsでElixirを高速化する方法をご覧ください。
  • ジョブレベルのMIX_ENV: testにより、すべてのステップがテスト環境を使用するため、キャッシュされコンパイルされるのは_build/testになります。
  • DATABASE_URLは、config/runtime.exsまたはconfig/test.exsがこれを読み取ることを前提としています。Phoenixのジェネレーターはecto://形式のURLを使用します。テスト設定でデータベースのホストをハードコードしている場合は、localhostと、上記のユーザー名とパスワードに設定してください。
  • --warnings-as-errorsは、コンパイラの警告があるとビルドを失敗させ、コードベースを clean な状態に保ちます。
  • サービスのヘルスチェック。これがないと、Postgresが接続を受け付ける前にecto.createが実行されてしまう可能性があります。

バリエーション

バージョンマトリックス

matrix.include に、otp: "26", elixir: "1.17" や otp: "27", elixir: "1.18" のような組み合わせを追加してください。互換性のあるバージョン同士を組み合わせます。詳しくは マトリックスビルド を参照してください。

静的解析

mix credo --strictと、dialyxirを使ったDialyzerを追加します。PLTの構築には数分かかるため、priv/pltsディレクトリをmix.lockをキーとして個別にキャッシュしてください。

アセット

esbuildとTailwindを使うPhoenixアプリでは、ページをレンダリングするテストの前にmix assets.setupとmix assets.buildが必要です。

テストのパーティション分割

Mixは--partitionsと組み合わせたMIX_TEST_PARTITIONをサポートしています。テストのシャーディングと組み合わせ、パーティションごとに別のデータベースを使用してください。

デプロイジョブ

mainでのみ実行される2つ目のジョブを追加します。このジョブはmix releaseでリリースをビルドし、それをアーティファクトとしてアップロードし、OIDCでデプロイします。

より高速なマシンで実行する

BEAMはテストを並行して実行するため、追加のコアが役立ちます。1行を変更してください:

    runs-on: [self-hosted, Linux, compiler-ci]

このジョブは、compiler.devの新しい8 vCPUマシン上で、自動フォールバック付きで実行されます。compiler.devのベンチマークでは、Postgresを使うPhoenix LiveViewアプリが2m07sから1m03sに短縮されました。詳細はベンチマークをご覧ください。価格は料金のページにあります。

よくある質問

なぜdepsに加えて_buildもキャッシュするのですか?

依存関係のコンパイルには時間がかかり、_buildはコンパイル結果を保持するためです。

キャッシュキーからOTPのバージョンを省略できますか?

リスクがあります。ある OTPバージョンでコンパイルされたbeamファイルは、別のOTPバージョンでは読み込めない場合があります。

互換性のあるOTPとElixirのバージョンはどうやって見つけますか?

Elixirの公式ドキュメントにある互換性の表には、各リリースでサポートされているOTPのバージョンが記載されています。

データベースが既に存在する場合、ecto.createは問題になりますか?

いいえ。データベースが既に存在することを報告し、処理を続行します。