-
Notifications
You must be signed in to change notification settings - Fork 26
146 lines (132 loc) · 4.25 KB
/
code_quality.yml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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/[email protected]
with:
apt-packages: 'libxml2-dev libxmlsec1-dev libxmlsec1-openssl gdal-bin'
python-version: '3.10'
setup-node: 'no'
- uses: isort/[email protected]
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/[email protected]
with:
apt-packages: 'libxml2-dev libxmlsec1-dev 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/[email protected]
with:
apt-packages: 'libxml2-dev libxmlsec1-dev 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/[email protected]
with:
apt-packages: 'libxml2-dev libxmlsec1-dev 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