ci.yml

name: CI

# Enable Buildkit and let compose use it to speed up image building
env:
  DOCKER_BUILDKIT: 1
  COMPOSE_DOCKER_CLI_BUILD: 1

on:
  pull_request:
    branches: [ 'master', 'main' ]
    paths-ignore: [ 'docs/**' ]

  push:
    branches: [ 'master', 'main' ]
    paths-ignore: [ 'docs/**' ]

concurrency:
  group: ${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  linter:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code Repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Run pre-commit
        uses: pre-commit/action@v3.0.1

  # With no caching at all the entire ci process takes 3m to complete!
  pytest:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code Repository
        uses: actions/checkout@v4

      - name: Set up environment files
        run: |
          mkdir -p .envs/dev
          echo "${{ secrets.DJANGO_ENV }}" > .envs/dev/.django

      - name: Build the Stack
        run: docker compose -f docker-compose.dev.yml build django

      - name: Check DB Migrations
        run: docker compose -f docker-compose.dev.yml run --rm django python manage.py makemigrations --check

      - name: Run DB Migrations
        run: docker compose -f docker-compose.dev.yml run --rm django python manage.py migrate

      - name: Run Django Tests
        run: docker compose -f docker-compose.dev.yml run django pytest

      - name: Tear down the Stack
        run: docker compose -f docker-compose.dev.yml down

      - name: Upload coverage to Coveralls
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}