-
Notifications
You must be signed in to change notification settings - Fork 3
221 lines (191 loc) · 6.49 KB
/
ci.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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
name: ci
# Run this workflow every time a new commit pushed to your repository
on:
push:
branches:
- master
tags:
- '*'
pull_request:
workflow_dispatch:
env:
IMAGE_NAME: maykinmedia/open-klant
DJANGO_SETTINGS_MODULE: openklant.conf.ci
DB_PASSWORD: ''
DB_USER: postgres
# ALLOWED_HOSTS: openklant.nl
jobs:
# determine changed files to decide if certain jobs can be skipped or not
changed-files:
runs-on: ubuntu-latest
name: Determine changed files
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Changed files
id: app-files
uses: tj-actions/changed-files@v45
with:
files: |
src/**/*.py
requirements/*.txt
- name: Display changed files
if: steps.app-files.outputs.any_changed == 'true'
env:
ALL_CHANGED_FILES: ${{ steps.app-files.outputs.all_changed_files }}
run: |
for file in ${ALL_CHANGED_FILES}; do
echo "$file was changed"
done
outputs:
changed-files: ${{ steps.app-files.outputs.any_changed }}
tests:
name: Tests (PG ${{ matrix.postgres }})
runs-on: ubuntu-latest
needs:
- changed-files
# only run tests if source files have changed (e.g. skip for PRs that only update docs)
if: needs.changed-files.outputs.changed-files == 'true' || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
strategy:
matrix:
postgres: ['13', '14', '15', '16']
services:
postgres:
image: postgres:${{ matrix.postgres }}
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
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- uses: actions/setup-node@v4
with:
node-version: '18'
- name: Install dependencies
run: pip install -r requirements/dev.txt codecov
- name: Build frontend
run: |
npm ci
npm run build
- name: Run tests
run: |
python src/manage.py collectstatic --noinput --link
coverage run src/manage.py test src
env:
DJANGO_SETTINGS_MODULE: openklant.conf.ci
SECRET_KEY: dummy
DB_USER: postgres
DB_PASSWORD: ''
- name: Publish coverage report
uses: codecov/codecov-action@v3
check-envvar-docs:
runs-on: ubuntu-latest
name: Documentation build
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
cache-dependency-path: 'requirements/*.txt'
- name: Install dependencies
run: pip install -r requirements/ci.txt pytest
- name: Generate environment variable documentation using OAf and check if it was updated
run: |
bin/generate_envvar_docs.sh
changes=$(git diff docs/installation/config.rst)
if [ ! -z "$changes" ]; then
echo $changes
echo "Please update the environment documentation by running \`bin/generate_envvar_docs.sh\`"
exit 1
fi
env:
DJANGO_SETTINGS_MODULE: openklant.conf.ci
docker:
needs: tests
name: Build Docker image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Determine tag/commit hash
id: vars
run: |
# Strip git ref prefix from version
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
# Strip "v" prefix from tag name (if present at all)
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
# Use Docker `latest` tag convention
[ "$VERSION" == "master" ] && VERSION=latest
echo "tag=${VERSION}" >> $GITHUB_OUTPUT
echo "git_hash=${GITHUB_SHA}" >> $GITHUB_OUTPUT
- name: Build the Docker image
run: |
docker build \
--tag $IMAGE_NAME:${{ steps.vars.outputs.tag }} \
--build-arg COMMIT_HASH=${{ steps.vars.outputs.git_hash }} \
--build-arg RELEASE=${{ steps.vars.outputs.tag }} \
.
- run: docker image save -o image.tar $IMAGE_NAME:${{ steps.vars.outputs.tag }}
- name: Store image artifact
uses: actions/upload-artifact@v3
with:
name: docker-image
path: image.tar
retention-days: 1
# image_scan:
# runs-on: ubuntu-latest
# name: Scan docker image
# needs:
# - docker
# steps:
# - name: Download built image
# uses: actions/download-artifact@v3
# with:
# name: docker-image
# - name: Scan image with Trivy
# uses: aquasecurity/trivy-action@master
# with:
# input: /github/workspace/image.tar # from download-artifact
# format: 'sarif'
# output: 'trivy-results-docker.sarif'
# ignore-unfixed: true
# - name: Upload results to GH Security tab
# uses: github/codeql-action/upload-sarif@v3
# with:
# sarif_file: 'trivy-results-docker.sarif'
publish:
needs:
- tests
- docker
name: Push Docker image
runs-on: ubuntu-latest
if: github.event_name == 'push' # exclude PRs
steps:
- uses: actions/checkout@v4
- name: Download built image
uses: actions/download-artifact@v3
with:
name: docker-image
- name: Determine tag/commit hash
id: vars
run: |
# Strip git ref prefix from version
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
# Strip "v" prefix from tag name (if present at all)
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
# Use Docker `latest` tag convention
[ "$VERSION" == "master" ] && VERSION=latest
echo "tag=${VERSION}" >> $GITHUB_OUTPUT
- name: Load image
run: |
docker image load -i image.tar
- name: Log into registry
run: echo "${{ secrets.DOCKER_TOKEN }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
- name: Push the Docker image
run: docker push $IMAGE_NAME:${{ steps.vars.outputs.tag }}