Django GitHub Actions ワークフローテンプレート
最終更新
これは、実際のPostgresデータベースに対してテストを実行するDjangoプロジェクト用の動作する.github/workflows/ci.ymlです。Postgresをサービスコンテナとして起動し、pipのキャッシュを有効にし、マイグレーションの漏れを確認してからテストを実行します。
ワークフロー
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
POSTGRES_DB: app_test
ports:
- 5432:5432
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 5s
--health-timeout 5s
--health-retries 10
env:
DATABASE_URL: postgres://postgres:postgres@localhost:5432/app_test
DJANGO_SETTINGS_MODULE: config.settings
SECRET_KEY: ci-only-not-a-secret
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
cache-dependency-path: requirements*.txt
- run: pip install -r requirements.txt
- run: python manage.py makemigrations --check --dry-run
- run: python manage.py test --parallel
分かりにくい部分の役割
services.postgresは、ジョブと並んでPostgresコンテナを起動します。ジョブはランナー上で直接実行されるため、データベースにはlocalhost:5432で接続でき、portsによって公開されます。optionsのヘルスチェックにより、pg_isreadyが成功するまでGitHubがステップの実行を待機します。これがないと、データベースに最初にアクセスするステップが不定期に失敗することがあり、不安定なテストの一般的な原因になります。DATABASE_URLは、dj-database-urlなどで解析する前提です。設定でDB_HOSTやDB_NAMEなどを読み込んでいる場合は、代わりにそれらを設定してください。DJANGO_SETTINGS_MODULEとSECRET_KEYはプレースホルダーです。モジュールのパスはご自身のものに変更してください。CIでは使い捨てのキーで問題ありません。本番環境のシークレットは、ここで決して再利用しないでください。makemigrations --check --dry-runは、モデルの変更に対応するマイグレーションファイルがない場合にビルドを失敗させます。test --parallelは、テストプロセスを並列に実行し、それぞれにテストデータベースを複製します。Postgresではこの方式でも問題ありません。テストにpytestを使用している場合は、代わりにpytest -n autoを実行してください(pytest-djangoとpytest-xdistが必要です)。cache: pipは、要件ファイルをキーとしてダウンロードをキャッシュします。詳しくはpipのキャッシュを参照してください。
バリエーション
Pythonバージョンのマトリックス
strategy.matrix.python: ["3.11", "3.12", "3.13"]を追加し、${{ matrix.python }}を使用します。引用符は残してください。詳しくはマトリックスビルドを参照してください。
RedisまたはCelery
同じ方法でredisサービスを追加します。redis:7と--health-cmd "redis-cli ping"を指定してください。
静的ファイルとリンティング
テストの前にruff check .を追加します。テストでマニフェストが必要なページをレンダリングする場合は、python manage.py collectstatic --noinputを追加してください。
デプロイジョブ
needs: testを指定した2つ目のジョブを追加し、mainでのみ実行されるようにします。クラウドの認証情報にはOIDCを使用してください。
より高速なマシンで実行する
データベースにアクセスするDjangoのテストスイートは、CPUとディスクの負荷が高くなります。次の1行を変更してください:
runs-on: [self-hosted, Linux, compiler-ci]
このジョブは、compiler.devが提供する新しい8 vCPUマシン上で実行され、元のランナーにフォールバックします。サービスコンテナも同じように動作します。チューニングのヒントはGitHub ActionsでDjangoを高速化するにあります。あわせて料金もご覧ください。
よくある質問
サービスコンテナは必要ですか、それともSQLiteを使えますか?
SQLiteの方が高速ですが、Postgres固有の動作が隠れてしまいます。本番環境でPostgresを使用している場合は、Postgres上でテストしてください。
テストデータベースへの接続が断続的に失敗するのはなぜですか?
通常は、ヘルスチェックが不足していることが原因です。optionsのブロックは残してください。
遅いDjangoのテストスイートを分割するにはどうすればよいですか?
コア数に応じて--parallelを使用し、ジョブをまたいでテストのシャーディングを行います。各シャードには個別のデータベースを用意してください。
これはWindowsやmacOSで実行できますか?
サービスコンテナはLinuxランナーでのみ動作します。データベースを使うテストはLinuxで実行してください。
関連記事
- GitHub ActionsでDjangoを高速化するpipまたはuvのキャッシュ、pytest-xdist、--reuse-db、Postgresサービス、テスト分割でGitHub ActionsのDjangoテストを高速化します。動作するYAML付き。
- .NET GitHub Actions ワークフローテンプレートNuGet のキャッシュ、リストア、ビルド、テストの手順と SQL Server サービスの選択肢、同時実行制御と権限設定を備えた、.NET 向けの GitHub Actions CI をコピーしてすぐ使えます。
- DockerビルドのGitHub ActionsワークフローテンプレートBuildx、GitHubのキャッシュレイヤー、mainへのプッシュ時のGHCRへのプッシュを使ってDockerイメージをビルドする、最小限の権限で動作するGitHub Actionsワークフローのコピー&ペースト用サンプルです。
- Elixir GitHub Actions ワークフローテンプレートPostgres サービスと、erlef/setup-beam による deps と _build のキャッシュ、フォーマットとテストを備えた、Elixir と Phoenix 向けの GitHub Actions CI をコピーしてすぐ使えます。