Tests workflow (sunscrapers/djoser)

The Tests workflow from sunscrapers/djoser, explained and optimized by Latchkey.

CI health: F - at risk

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: sunscrapers/djoser.github/workflows/test-suite.ymlLicense MITView source

What it does

This is the Tests workflow from the sunscrapers/djoser repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: Tests
on:
  push:
    branches:
      - master
  pull_request:
  schedule:
    - cron: '0 0 * * 0'

jobs:
  django3-test:
    name: Django 3 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9, '3.10', 3.11]
        django-version: [3.2.18]
        drf-version: [3.14]

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django3-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django3-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django3-

      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-

      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"

      - name: Install dependencies
        run: poetry install --only main,test --all-extras

      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi

      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"

      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'

      - name: Run tests
        run: make test

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}

  django4-test:
    name: Django 4 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9, '3.10', 3.11]
        django-version: [4.0, 4.1, 4.2]
        drf-version: [3.14]
        include:
          # Test latest Django stable with newest Python versions
          - python-version: '3.10'
            django-version: "latest"
            drf-version: 3.14
          - python-version: 3.11
            django-version: "latest"
            drf-version: 3.14

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django4-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django4-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django4-

      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-

      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"

      - name: Install dependencies
        run: poetry install --only main,test --all-extras

      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi

      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"

      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'

      - name: Run tests
        run: make test

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}

  django5-test:
    name: Django 5 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10', 3.11, 3.12, 3.13]
        django-version: ["5.0.12", "5.1.6", "5.2.0"]
        drf-version: [3.14]
        include:
          # Test latest Django with newest Python
          - python-version: 3.12
            django-version: "latest"
            drf-version: 3.14
          - python-version: 3.13
            django-version: "latest"
            drf-version: 3.14

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django5-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django5-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django5-

      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-

      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"

      - name: Install dependencies
        run: poetry install --only main,test --all-extras

      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi

      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"

      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'

      - name: Run tests
        run: make test

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}

  lock-file-check:
    name: Check poetry.lock for changes
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"

      - name: Install dependencies to check poetry.lock
        run: poetry install

      - name: Check if poetry.lock is up to date
        run: poetry check --lock

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: Tests
on:
  push:
    branches:
      - master
  pull_request:
  schedule:
    - cron: '0 0 * * 0'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  django3-test:
    timeout-minutes: 30
    name: Django 3 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9, '3.10', 3.11]
        django-version: [3.2.18]
        drf-version: [3.14]
 
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django3-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django3-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django3-
 
      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django3-py${{ matrix.python-version }}-
 
      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"
 
      - name: Install dependencies
        run: poetry install --only main,test --all-extras
 
      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi
 
      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"
 
      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'
 
      - name: Run tests
        run: make test
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}
 
  django4-test:
    timeout-minutes: 30
    name: Django 4 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9, '3.10', 3.11]
        django-version: [4.0, 4.1, 4.2]
        drf-version: [3.14]
        include:
          # Test latest Django stable with newest Python versions
          - python-version: '3.10'
            django-version: "latest"
            drf-version: 3.14
          - python-version: 3.11
            django-version: "latest"
            drf-version: 3.14
 
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django4-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django4-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django4-
 
      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django4-py${{ matrix.python-version }}-
 
      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"
 
      - name: Install dependencies
        run: poetry install --only main,test --all-extras
 
      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi
 
      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"
 
      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'
 
      - name: Run tests
        run: make test
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}
 
  django5-test:
    timeout-minutes: 30
    name: Django 5 - Python ${{ matrix.python-version }} - Django ${{ matrix.django-version }} - DRF ${{ matrix.drf-version }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10', 3.11, 3.12, 3.13]
        django-version: ["5.0.12", "5.1.6", "5.2.0"]
        drf-version: [3.14]
        include:
          # Test latest Django with newest Python
          - python-version: 3.12
            django-version: "latest"
            drf-version: 3.14
          - python-version: 3.13
            django-version: "latest"
            drf-version: 3.14
 
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-django5-${{ hashFiles('**/poetry.lock') }}-${{ matrix.django-version }}
          restore-keys: |
            ${{ runner.os }}-poetry-django5-${{ hashFiles('**/poetry.lock') }}-
            ${{ runner.os }}-poetry-django5-
 
      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-django${{ matrix.django-version }}-drf${{ matrix.drf-version }}-
            ${{ runner.os }}-venv-django5-py${{ matrix.python-version }}-
 
      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"
 
      - name: Install dependencies
        run: poetry install --only main,test --all-extras
 
      - name: Install Django version
        run: |
          if [ "${{ matrix.django-version }}" = "latest" ]; then
            poetry run pip install --upgrade "Django"  # Force upgrade to latest
          else
            # First try exact version, if it fails try to install the major.minor version
            echo "Installing Django ${{ matrix.django-version }}..."
            if ! poetry run pip install "Django==${{ matrix.django-version }}"; then
              echo "Exact version failed, trying to install the latest patch version..."
              MAJOR_MINOR=$(echo "${{ matrix.django-version }}" | cut -d. -f1,2)
              poetry run pip install "Django~=$MAJOR_MINOR.0"
            fi
          fi
 
      - name: Install DRF version
        run: poetry run pip install --upgrade "djangorestframework==${{ matrix.drf-version }}"
 
      - name: Show environment info
        run: |
          poetry run python --version
          poetry run pip freeze | grep -E 'djangorestframework|Django'
 
      - name: Run tests
        run: make test
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v5
        continue-on-error: true
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}
 
  lock-file-check:
    timeout-minutes: 30
    name: Check poetry.lock for changes
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: "3.11"
 
      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"
 
      - name: Install dependencies to check poetry.lock
        run: poetry install
 
      - name: Check if poetry.lock is up to date
        run: poetry check --lock

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

2 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

This workflow runs 4 jobs (25 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python actions/cache codecov/codecov-action