Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para Django

Última actualización

Este es un .github/workflows/ci.yml funcional para un proyecto Django que realiza las pruebas con una base de datos Postgres real. Inicia Postgres como contenedor de servicio junto al job, almacena en caché pip, comprueba si faltan migraciones y ejecuta sus pruebas.

El flujo de trabajo

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

Qué hacen las partes menos evidentes

  • services.postgres inicia un contenedor Postgres junto al job. Como el job se ejecuta directamente en el runner, se conecta a la base de datos en localhost:5432, y ports la publica.
  • La comprobación de estado options hace que GitHub espere hasta que pg_isready se ejecute correctamente antes de ejecutar los pasos. Sin ella, el primer paso que accede a la base de datos puede fallar de forma aleatoria, una causa habitual de pruebas inestables.
  • DATABASE_URL supone que la analiza con dj-database-url o una herramienta similar. Si su configuración lee DB_HOST, DB_NAME y otras variables, defínalas en su lugar.
  • DJANGO_SETTINGS_MODULE y SECRET_KEY son valores de ejemplo. Cambie la ruta del módulo por la suya. En CI basta con una clave temporal; no reutilice aquí un secreto de producción.
  • makemigrations --check --dry-run hace que la compilación falle si un cambio en un modelo no tiene su archivo de migración.
  • test --parallel ejecuta los procesos de prueba en paralelo y clona la base de datos de prueba para cada uno. Postgres admite este modo sin problemas. Si sus pruebas usan pytest, ejecute pytest -n auto en su lugar (requiere pytest-django y pytest-xdist).
  • cache: pip almacena en caché las descargas, usando como clave los archivos de requisitos. Consulte almacenamiento en caché de pip.

Variantes

Matriz de versiones de Python

Añada strategy.matrix.python: ["3.11", "3.12", "3.13"] y use ${{ matrix.python }}. Mantenga las comillas. Consulte compilaciones con matriz.

Redis o Celery

Añada un servicio redis de la misma forma, con redis:7 y --health-cmd "redis-cli ping".

Archivos estáticos y linting

Añada ruff check . antes de las pruebas y python manage.py collectstatic --noinput si sus pruebas renderizan páginas que necesitan el manifiesto.

Job de despliegue

Añada un segundo job con needs: test que solo se ejecute en main. Use OIDC para las credenciales de la nube.

Ejecútelo en máquinas más rápidas

Las suites de Django que acceden a la base de datos están limitadas por la CPU y el disco. Cambie una línea:

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

El job se ejecuta en una máquina nueva de 8 vCPU de compiler.dev, con recurso alternativo a su runner original. El contenedor de servicio funciona igual. Consejos de ajuste en cómo acelerar Django en GitHub Actions; consulte también precios.

Preguntas frecuentes

¿Necesito un contenedor de servicio o puedo usar SQLite?

SQLite es más rápido, pero oculta el comportamiento específico de Postgres. Si producción usa Postgres, pruebe con Postgres.

¿Por qué falla de forma intermitente la conexión a la base de datos de prueba?

Normalmente por falta de comprobación de estado. Mantenga el bloque options.

¿Cómo divido una suite de pruebas de Django lenta?

Use --parallel para los núcleos y fragmentación de pruebas entre jobs, con una base de datos independiente por fragmento.

¿Puedo ejecutar esto en Windows o macOS?

Los contenedores de servicio solo funcionan en runners Linux. Use Linux para las pruebas con base de datos.