Django GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist eine funktionsfähige .github/workflows/ci.yml für ein Django-Projekt, das gegen eine echte Postgres-Datenbank testet. Sie startet Postgres als Service-Container, cached pip, prüft auf fehlende Migrationen und führt Ihre Tests aus.
Der Workflow
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
Was die nicht offensichtlichen Teile bewirken
services.postgresstartet einen Postgres-Container neben dem Job. Da der Job direkt auf dem Runner läuft, erreicht er die Datenbank unterlocalhost:5432, undportsmacht sie verfügbar.- Der Health-Check in
optionssorgt dafür, dass GitHub wartet, bispg_isreadyerfolgreich ist, bevor Schritte ausgeführt werden. Ohne ihn kann der erste Schritt, der auf die Datenbank zugreift, zufällig fehlschlagen, eine häufige Ursache für instabile Tests. DATABASE_URLsetzt voraus, dass Sie sie mitdj-database-urloder ähnlichem auswerten. Lesen Ihre EinstellungenDB_HOST,DB_NAMEusw., setzen Sie stattdessen diese Variablen.DJANGO_SETTINGS_MODULEundSECRET_KEYsind Platzhalter. Passen Sie den Modulpfad an Ihren an. Ein Wegwerfschlüssel ist in CI unproblematisch; verwenden Sie hier niemals ein Produktionsgeheimnis.makemigrations --check --dry-runlässt den Build fehlschlagen, wenn einer Modelländerung die Migrationsdatei fehlt.test --parallelführt Testprozesse parallel aus und klont die Testdatenbank für jeden davon. Postgres kommt damit gut zurecht. Wenn Ihre Tests pytest verwenden, führen Sie stattdessenpytest -n autoaus (benötigtpytest-djangoundpytest-xdist).cache: pipcached Downloads anhand der Requirements-Dateien. Siehe pip-Caching.
Varianten
Python-Versionsmatrix
Fügen Sie strategy.matrix.python: ["3.11", "3.12", "3.13"] hinzu und verwenden Sie ${{ matrix.python }}. Behalten Sie die Anführungszeichen bei. Siehe Matrix-Builds.
Redis oder Celery
Fügen Sie einen redis-Service auf dieselbe Weise hinzu, mit redis:7 und --health-cmd "redis-cli ping".
Statische Dateien und Linting
Fügen Sie ruff check . vor den Tests hinzu sowie python manage.py collectstatic --noinput, falls Ihre Tests Seiten rendern, die das Manifest benötigen.
Deploy-Job
Fügen Sie einen zweiten Job mit needs: test hinzu, der nur auf main läuft. Verwenden Sie OIDC für Cloud-Zugangsdaten.
Auf schnelleren Maschinen ausführen
Django-Suites, die auf die Datenbank zugreifen, sind CPU- und festplattenintensiv. Ändern Sie eine Zeile:
runs-on: [self-hosted, Linux, compiler-ci]
Der Job läuft auf einer frischen Maschine mit 8 vCPU von compiler.dev, mit Rückfall auf Ihren ursprünglichen Runner. Der Service-Container funktioniert auf die gleiche Weise. Tuning-Tipps finden Sie unter Django auf GitHub Actions beschleunigen; siehe auch Preise.
FAQ
Brauche ich einen Service-Container oder kann ich SQLite verwenden?
SQLite ist schneller, verdeckt aber Postgres-spezifisches Verhalten. Wenn die Produktion Postgres einsetzt, testen Sie auch auf Postgres.
Warum schlägt die Verbindung zur Testdatenbank gelegentlich fehl?
Meist fehlt der Health-Check. Behalten Sie den Block options bei.
Wie teile ich eine langsame Django-Testsuite auf?
Verwenden Sie --parallel für die Kerne und Test-Sharding über mehrere Jobs, mit einer eigenen Datenbank pro Shard.
Kann ich das unter Windows oder macOS ausführen?
Service-Container funktionieren nur auf Linux-Runnern. Bleiben Sie für datenbankbasierte Tests bei Linux.
Verwandt
- Django in GitHub Actions beschleunigenDjango-Tests in GitHub Actions beschleunigen: pip- oder uv-Caching, pytest-xdist, --reuse-db, Postgres-Service und Test-Splitting. Funktionierendes YAML.
- .NET GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für .NET mit NuGet-Cache, Restore-, Build- und Test-Schritten, optionalem SQL-Server-Dienst, Concurrency und Berechtigungen.
- Docker Build GitHub Actions Workflow VorlageFertiger GitHub-Actions-Workflow zum Bauen von Docker-Images mit Buildx, GitHub-Cache-Layern und einem Push zu GHCR auf main, mit minimalen Berechtigungen.
- Elixir GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Elixir und Phoenix mit Postgres-Service, Caching von deps und _build über erlef/setup-beam sowie Formatierung und Tests.