-
Notifications
You must be signed in to change notification settings - Fork 0
245 lines (198 loc) · 7.01 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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
---
name: CI
on: # yamllint disable-line rule:truthy
push:
branches:
- main # forward-compatibility with new GitHub default branch naming
- master # backward-compatibility with old GitHub default branch naming
pull_request:
branches:
- main # forward-compatibility with new GitHub default branch naming
- master # backward-compatibility with old GitHub default branch naming
workflow_dispatch:
jobs:
# Quality jobs ----------------------
code-quality:
name: Code Quality
runs-on: "ubuntu-latest"
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4.3.1
with:
python-version: "3.10"
- name: Install Poetry
run: |
pip install --constraint=.github/workflows/constraints.txt poetry
poetry --version
- name: Configure Poetry
run: |
poetry config cache-dir "${GITHUB_WORKSPACE}/.cache/pypoetry"
poetry config virtualenvs.in-project true
poetry config --list
- name: Install Tox
run: |
pip install --constraint=.github/workflows/constraints.txt tox
tox --version
- name: Load cached tox testenv(s) (if they exist)
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: |
.tox
key: tox-${{ github.workflow }}-${{ github.job }}-${{ runner.os }}-CPython${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install Go for pre-commit hook (shfmt)
run: |
GO_TAR=go1.16.linux-amd64.tar.gz && \
wget --quiet https://golang.org/dl/$GO_TAR && \
sudo tar -C /usr/local -xzf $GO_TAR && \
rm $GO_TAR && \
export GO111MODULE=on && \
export CGO_ENABLED=0 && \
export GOOS=linux && \
export GOARCH=amd64 && \
sudo ln -sf /usr/local/go/bin/go /usr/bin/go
- name: Run static analysis
run: |
make pre-commit || true
# Security jobs ----------------------
dependency-security-vulnerability-analysis:
name: Dependency Security Vulnerability Analysis
runs-on: "ubuntu-latest"
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4.3.1
with:
python-version: "3.10"
- name: Install Poetry
run: |
pip install --constraint=.github/workflows/constraints.txt poetry
poetry --version
- name: Configure Poetry
run: |
poetry config cache-dir "${GITHUB_WORKSPACE}/.cache/pypoetry"
poetry config virtualenvs.in-project true
poetry config --list
- name: Install Tox
run: |
pip install --constraint=.github/workflows/constraints.txt tox
tox --version
- name: Load cached tox testenv(s) (if they exist)
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: |
.tox
key: tox-${{ github.workflow }}-${{ github.job }}-${{ runner.os }}-CPython${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Run dependency security vulnerability analysis
run: |
make scan-dependencies
# Code quality AND security job ----------------------
semgrep:
runs-on: ubuntu-latest
name: Semgrep
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Disable Git LFS
run: |
rm .git/hooks/post-checkout || true
- name: Run Semgrep
id: semgrep
uses: returntocorp/semgrep-action@v1
with:
config: r/python
# Tests jobs ------------------------
test:
strategy:
matrix:
os: ["ubuntu-latest", "macos-latest"]
python-version: ["3.10"]
name: Python ${{ matrix.python-version }} (${{ matrix.os }})
runs-on: ${{ matrix.os }}
env:
USING_COVERAGE_OS: "ubuntu"
USING_COVERAGE_PY_VER: "3.10"
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4.3.1
with:
python-version: ${{ matrix.python-version }}
- name: Install Poetry
run: |
pip install --constraint=.github/workflows/constraints.txt poetry
poetry --version
- name: Configure Poetry
run: |
poetry config cache-dir "${GITHUB_WORKSPACE}/.cache/pypoetry"
poetry config virtualenvs.in-project true
poetry config --list
- name: Install Tox & Tox GH Actions Plugin
run: |
pip install --constraint=.github/workflows/constraints.txt tox tox-gh-actions
tox --version
- name: Load cached tox testenv(s) (if they exist)
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: |
.tox
key: tox-${{ github.workflow }}-${{ github.job }}-${{ runner.os }}-CPython${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Run tox targets for ${{ matrix.python-version }}
run: |
git fetch origin master:refs/remotes/origin/master
make test
- name: Upload coverage to Codecov
if: "contains(matrix.os, env.USING_COVERAGE_OS) &&
contains(matrix.python-version, env.USING_COVERAGE_PY_VER)"
uses: "codecov/codecov-action@v3.1.1"
with:
file: ./.tox/coverage.xml
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
# Documentation build testing jobs ------------------------
test-documentation-building:
strategy:
matrix:
python-version: ["3.10"]
name: Documentation build testing
runs-on: "ubuntu-latest"
steps:
- name: Check out the repository
uses: actions/checkout@v3.0.2
- name: Set up Python
uses: actions/setup-python@v4.3.1
with:
python-version: ${{ matrix.python-version }}
- name: Install Poetry
run: |
pip install --constraint=.github/workflows/constraints.txt poetry
poetry --version
- name: Configure Poetry
run: |
poetry config cache-dir "${GITHUB_WORKSPACE}/.cache/pypoetry"
poetry config virtualenvs.in-project true
poetry config --list
- name: Load cached venv(s) (if they exist)
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: |
.venv
key: venv-${{ runner.os }}-CPython${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: |
make install-dependencies
- name: Install project
run: |
make install-project
- name: Build Documentation
run: |
make docs-html \
LAUNCH_DOCS_PREVIEW=false