Skip to content
Code quality checks

[#458] Add django setup configuration and ZGW steps #1030

Sign in to view logs

[#458] Add django setup configuration and ZGW steps

[#458] Add django setup configuration and ZGW steps #1030

Workflow file for this run

.github/workflows/code_quality.yml at 8fa92f0
name: Code quality checks
# Run this workflow every time a new commit pushed to your repository
on:
push:
branches:
- main
- 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@v3
- name: Set up backend environment
uses: maykinmedia/[email protected]
with:
python-version: '3.12'
setup-node: 'no'
working-directory: backend
- uses: isort/[email protected]
with:
requirements-files: requirements/ci.txt
sort-paths: 'backend/src backend/docs backend/bin'
configuration: '--check-only --diff'
black:
name: Check code formatting with black
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up backend environment
uses: maykinmedia/[email protected]
with:
python-version: '3.12'
setup-node: 'no'
working-directory: backend
- name: Run black
run: black --check src docs bin
working-directory: backend
flake8:
name: Code style (flake8)
runs-on: ubuntu-latest
defaults:
run:
working-directory: backend
steps:
- uses: actions/checkout@v3
- name: Set up backend environment
uses: maykinmedia/[email protected]
with:
python-version: '3.12'
setup-node: 'no'
working-directory: backend
- 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_REPORT=${report}" >> $GITHUB_OUTPUT
exit $result_code
- name: Emit flake8 flake8 output
if: ${{ failure() }}
run: |
echo "${{ steps.flake8.outputs.FLAKE8_REPORT }}"
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_REPORT }}" >> $GITHUB_STEP_SUMMARY
# ui-prettier:
# name: Check frontend code formatting with prettier
# runs-on: ubuntu-latest
#
# defaults:
# run:
# working-directory: ui
#
# steps:
# - uses: actions/checkout@v3
# - uses: actions/setup-node@v3
# with:
# node-version-file: 'ui/.nvmrc'
#
# - name: Install dependencies
# run: npm ci --legacy-peer-deps
#
# - name: Run prettier linter
# run: npm run checkformat
migrations:
name: Check for model changes not present in migrations
runs-on: ubuntu-latest
defaults:
run:
working-directory: backend
services:
postgres:
image: postgis/postgis:14-3.4
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@v3
- name: Set up backend environment
uses: maykinmedia/[email protected]
with:
apt-packages: 'gettext postgresql-client libgdal-dev gdal-bin'
python-version: '3.12'
setup-node: 'no'
working-directory: backend
- name: Run makemigrations to check for missing migrations
working-directory: backend
run: |
src/manage.py makemigrations \
--check \
--dry-run
env:
DJANGO_SETTINGS_MODULE: "openarchiefbeheer.conf.ci"
DEBUG: 'true'
SECRET_KEY: dummy
DB_USER: postgres
DB_NAME: postgres
DB_PASSWORD: ''