Code Quality workflow (sunscrapers/djoser)

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

What it does

This is the Code Quality 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

name: Code Quality
on:
  push:
    branches:
      - master
  pull_request:

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

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

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

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

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

      - name: Install dependencies
        run: poetry install --only code-quality

      - name: Run pre-commit with debug
        run: |
          echo "Running pre-commit hooks with verbose output..."
          poetry run pre-commit run --all-files --verbose
          if [ $? -ne 0 ]; then
            echo "Pre-commit failed. Showing git status:"
            git status
            echo "Showing git diff:"
            git diff
            exit 1
          fi

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: Code Quality
on:
  push:
    branches:
      - master
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  code-quality:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: "3.11"
 
      - name: Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-quality-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-poetry-quality-
 
      - name: Setup Poetry
        uses: abatilo/actions-poetry@v4
        with:
          poetry-version: "1.8.4"
 
      - name: Cache virtual environment
        uses: actions/cache@v4
        with:
          path: .venv
          key: ${{ runner.os }}-venv-${{ hashFiles('**/poetry.lock') }}
          restore-keys: |
            ${{ runner.os }}-venv-
 
      - name: Install dependencies
        run: poetry install --only code-quality
 
      - name: Run pre-commit with debug
        run: |
          echo "Running pre-commit hooks with verbose output..."
          poetry run pre-commit run --all-files --verbose
          if [ $? -ne 0 ]; then
            echo "Pre-commit failed. Showing git status:"
            git status
            echo "Showing git diff:"
            git diff
            exit 1
          fi
 

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.

1 third-party action is referenced by a movable tag. Pin it 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 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow