コンテンツへスキップ

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

最終更新

これは、MySQL に対してテストされる Laravel アプリ向けの、動作する .github/workflows/ci.yml です。setup-php で PHP をインストールし、Composer のダウンロードをキャッシュし、.env を作成し、データベースのマイグレーションを実行して、Pint とテストスイートを実行します。

ワークフロー

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:
      mysql:
        image: mysql:8.0
        env:
          MYSQL_ROOT_PASSWORD: root
          MYSQL_DATABASE: laravel_test
        ports:
          - 3306:3306
        options: >-
          --health-cmd "mysqladmin ping -h 127.0.0.1 -proot"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 20
    env:
      APP_ENV: testing
      DB_CONNECTION: mysql
      DB_HOST: 127.0.0.1
      DB_PORT: 3306
      DB_DATABASE: laravel_test
      DB_USERNAME: root
      DB_PASSWORD: root
    steps:
      - uses: actions/checkout@v4

      - uses: shivammathur/setup-php@v2
        with:
          php-version: "8.3"
          extensions: mbstring, pdo_mysql, bcmath
          coverage: none

      - name: Get Composer cache directory
        id: composer-cache
        run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT"

      - uses: actions/cache@v4
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: composer-${{ runner.os }}-${{ hashFiles('composer.lock') }}
          restore-keys: |
            composer-${{ runner.os }}-

      - run: composer install --no-interaction --prefer-dist --no-progress
      - run: cp .env.example .env
      - run: php artisan key:generate
      - run: vendor/bin/pint --test
      - run: php artisan migrate --force
      - run: php artisan test --parallel

分かりにくい部分の役割

  • shivammathur/setup-php@v2 は、指定した PHP のバージョンと拡張機能をインストールします。coverage: none を指定すると Xdebug と PCOV が無効になり、テストが高速化されます。カバレッジを取得する場合のみ coverage: pcov を設定してください。
  • Composer キャッシュのステップは、vendor/ ではなく Composer のダウンロードキャッシュを保存します。ディレクトリのパスは Composer 自身から取得するため、どのランナーでも正しく機能します。キーは composer.lock のハッシュ値です。
  • MySQL のヘルスチェックは、127.0.0.1 とルートパスワードを使用します。MySQL の初期化には数秒かかるため、リトライ回数を多めに設定して、起動直後の接続エラーを回避しています。
  • DB_HOST: 127.0.0.1 は意図的な設定です。localhost を指定すると、PHP の MySQL ドライバーは存在しない Unix ソケットへの接続を試みて失敗します。
  • cp .env.example .env と key:generate により、実際の機密情報を使わずに、アプリに有効な環境設定と APP_KEY を用意します。
  • pint --test は、ファイルを書き換えずにスタイルの問題を報告します。そのため、CI は問題を黙って修正するのではなく、失敗として終了します。
  • artisan test --parallel を使うには brianium/paratest パッケージが必要で、プロセスごとにデータベースが作成されます。使用しない場合は、このフラグを削除してください。

バリエーション

PHP バージョンのマトリックス

matrix.php: ["8.2", "8.3", "8.4"] を追加し、${{ matrix.php }} を使用します。バージョンは引用符で囲んだままにしてください。マトリックスビルドを参照してください。

フロントエンドのアセット

actions/setup-node@v4 を cache: npm とともに追加し、機能テストで Vite アセットをレンダリングする場合は、テストの前に npm ci と npm run build を実行します。

Postgres または SQLite

サービスを postgres:16 に置き換え、pg_isready を使用して、DB_CONNECTION: pgsql を設定します。インメモリの SQLite はサービスが不要で高速ですが、データベースエンジンの違いは見えなくなります。

デプロイジョブ

needs: test を指定した 2 つ目のジョブを、main ブランチに対してのみ実行するように追加し、クラウドへのアクセスには OIDC を使用します。

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

1 行を変更します:

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

このジョブは compiler.dev の新しい 8 vCPU マシンで実行され、元のランナーに自動でフォールバックします。並列テストは追加のコアを有効に活用します。GitHub Actions で Laravel を高速化する方法と料金もご覧ください。

よくある質問

vendor ディレクトリをキャッシュすべきですか?

代わりに Composer のダウンロードキャッシュをキャッシュしてください。ウォームキャッシュからの composer install は高速で、常に composer.lock と整合します。

起動直後に MySQL が接続を拒否するのはなぜですか?

まだ起動中だからです。ヘルスチェックを残し、127.0.0.1 を使用してください。

Dusk のブラウザテストはどのように実行しますか?

Dusk には Chrome と稼働中のアプリサーバーが必要です。ブラウザテストの遅延がユニットテストに影響しないよう、別のジョブで実行し、スクリーンショットは アーティファクトとしてアップロードしてください。

CI で Sail を使用できますか?

使用できますが、Docker の起動時間が追加されます。通常は setup-php とサービスコンテナを組み合わせる方が高速です。