Zum Inhalt springen

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.postgres startet einen Postgres-Container neben dem Job. Da der Job direkt auf dem Runner läuft, erreicht er die Datenbank unter localhost:5432, und ports macht sie verfügbar.
  • Der Health-Check in options sorgt dafür, dass GitHub wartet, bis pg_isready erfolgreich 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_URL setzt voraus, dass Sie sie mit dj-database-url oder ähnlichem auswerten. Lesen Ihre Einstellungen DB_HOST, DB_NAME usw., setzen Sie stattdessen diese Variablen.
  • DJANGO_SETTINGS_MODULE und SECRET_KEY sind Platzhalter. Passen Sie den Modulpfad an Ihren an. Ein Wegwerfschlüssel ist in CI unproblematisch; verwenden Sie hier niemals ein Produktionsgeheimnis.
  • makemigrations --check --dry-run lässt den Build fehlschlagen, wenn einer Modelländerung die Migrationsdatei fehlt.
  • test --parallel fü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 stattdessen pytest -n auto aus (benötigt pytest-django und pytest-xdist).
  • cache: pip cached 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.