Merge pull request #4676 from open-formulieren/backport-2.7.x/4602-mi… #10766
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Code quality checks | |
| # Run this workflow every time a new commit pushed to your repository | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - stable/* | |
| tags: | |
| paths: | |
| - '**.py' | |
| - '**.json' | |
| - '**.yaml' | |
| - '**.in' | |
| pull_request: | |
| paths: | |
| - '**.py' | |
| - '**.json' | |
| - '**.yaml' | |
| - '**.in' | |
| workflow_dispatch: | |
| jobs: | |
| isort: | |
| name: Check import sorting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up backend environment | |
| uses: maykinmedia/setup-django-backend@v1.3 | |
| with: | |
| apt-packages: 'libxml2 libxmlsec1 libxmlsec1-openssl gdal-bin' | |
| python-version: '3.10' | |
| setup-node: 'no' | |
| - uses: isort/isort-action@v1.1.0 | |
| with: | |
| requirements-files: requirements/ci.txt | |
| sort-paths: 'src docs' | |
| configuration: '--check-only --diff' | |
| black: | |
| name: Check code formatting with black | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up backend environment | |
| uses: maykinmedia/setup-django-backend@v1.3 | |
| with: | |
| apt-packages: 'libxml2 libxmlsec1 libxmlsec1-openssl gdal-bin' | |
| python-version: '3.10' | |
| setup-node: 'no' | |
| - name: Run black | |
| run: | | |
| black --check src docs | |
| flake8: | |
| name: Code style (flake8) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up backend environment | |
| uses: maykinmedia/setup-django-backend@v1.3 | |
| with: | |
| apt-packages: 'libxml2 libxmlsec1 libxmlsec1-openssl gdal-bin' | |
| python-version: '3.10' | |
| setup-node: 'no' | |
| - name: Run flake8 | |
| id: flake8 | |
| run: | | |
| flake8 src 2>&1 | tee flake8_output.txt | |
| result_code=${PIPESTATUS[0]} | |
| report="$(cat flake8_output.txt)" | |
| report="${report//$'\n'/'%0A'}" # escape newlines | |
| echo "flake8_output=${report}" >> $GITHUB_OUTPUT | |
| exit $result_code | |
| - name: Emit flake8 flake8 output | |
| if: ${{ failure() }} | |
| run: | | |
| echo "${{ steps.flake8.outputs.flake8_output }}" | |
| echo 'flake8 found some issues' >> $GITHUB_STEP_SUMMARY | |
| echo '' >> $GITHUB_STEP_SUMMARY | |
| echo '| File | Line | Column | Issue |' >> $GITHUB_STEP_SUMMARY | |
| echo '| :--- | ---- | ------ | :---- |' >> $GITHUB_STEP_SUMMARY | |
| python ./bin/flake8_summary.py "${{ steps.flake8.outputs.flake8_output }}" >> $GITHUB_STEP_SUMMARY | |
| migrations: | |
| name: Check for model changes not present in the migrations or default_admin_index fixture | |
| runs-on: ubuntu-latest | |
| services: | |
| postgres: | |
| image: postgres:12 | |
| 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: maykinmedia/setup-django-backend@v1.3 | |
| with: | |
| apt-packages: 'libxml2 libxmlsec1 libxmlsec1-openssl gdal-bin' | |
| python-version: '3.10' | |
| setup-node: '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.10' | |
| - name: Run linter | |
| run: python ./bin/lint_dependencies.py |