open-forms/.github/workflows/code_quality.yml at main · open-formulieren/open-forms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
name: Code quality checks

# Run this workflow every time a new commit pushed to your repository
on:
  push:
    branches:
      - main
      - stable/*
    tags:
      - '*'
  pull_request:
  workflow_dispatch:

jobs:
  ruff:
    name: Ruff - lint and check code formatting
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Determine ruff version
        id: ruff-version
        run: |
          version=$(grep -oP '(?<=ruff==)\d+\.\d+\.\d+' requirements/ci.txt)
          echo "version=$version" >> $GITHUB_OUTPUT
      - uses: astral-sh/ruff-action@v3  # runs ruff check
        with:
          version: "${{ steps.ruff-version.outputs.version }}"
      - run: ruff format --check --diff

  migrations:
    name: Check for model changes not present in the migrations or default_admin_index fixture
    runs-on: ubuntu-latest

    services:
      postgres:
        image: postgres:15
        env:
          POSTGRES_HOST_AUTH_METHOD: trust
        ports:
          - 5432:5432
        # Needed because the postgres container does not provide a healthcheck
        options:
          --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

    steps:
      - uses: actions/checkout@v4
      - name: Set up backend environment
        uses: ./.github/actions/setup-backend
        with:
          setup-node: 'no'
          optimize-postgres: 'no'
      - name: Run manage.py makemigrations --check --dry-run
        run: |
          src/manage.py makemigrations --check --dry-run
        env:
          DJANGO_SETTINGS_MODULE: openforms.conf.ci
          DEBUG: 'true'
          SECRET_KEY: dummy
          DB_USER: postgres
          DB_NAME: postgres
          DB_PASSWORD: ''
      - name: Load default_admin_index fixture and run manage.py check_admin_index
        run: |
          src/manage.py migrate
          src/manage.py loaddata default_admin_index
          src/manage.py check_admin_index
        env:
          DJANGO_SETTINGS_MODULE: openforms.conf.ci
          SECRET_KEY: dummy
          DB_USER: postgres
          DB_NAME: postgres
          DB_PASSWORD: ''

  dependencies:
    name: Lint dependencies
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Run linter
        run: python ./bin/lint_dependencies.py

  type-checking:
    name: Type checking (Pyright)
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install additional dependencies
        run: |
          pip install uv
          uv pip install \
            --system \
            -r requirements/type-checking.txt
      - name: Create dummy local.py settings file
        run: touch src/openforms/conf/local.py
      - uses: jakebailey/pyright-action@v1
        with:
          version: 1.1.407
          project: pyright.pyproject.toml