568 lines (477 loc) · 17.7 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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
name: CI
on: [push, pull_request]
jobs:
test:
runs-on: ${{ matrix.os }}
name: test${{ matrix.name-suffix }} (${{ matrix.os }}, ${{ matrix.build-type }})
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
build-type: [Release, Debug]
name-suffix: [""]
openmp: [false]
single-precision: [false]
include:
- build-type: Debug
excludetests: solver
- openmp: true
name-suffix: "-openmp"
os: ubuntu-latest
build-type: Release
- openmp: true
name-suffix: "-openmp"
os: macos-latest
build-type: Release
- openmp: true
name-suffix: "-openmp"
os: windows-latest
build-type: Release
- single-precision: true
name-suffix: "-single-precision"
os: ubuntu-latest
build-type: Release
- single-precision: true
name-suffix: "-single-precision"
os: macos-latest
build-type: Release
- single-precision: true
name-suffix: "-single-precision"
os: windows-latest
build-type: Release
env:
BUILD_TYPE: ${{ matrix.build-type }}
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=ON -DSPIRIT_UI_CXX_USE_QT=OFF
OMP_NUM_THREADS: 4
EXCLUDETESTS: ${{ matrix.excludetests }}
steps:
- uses: actions/checkout@v3
- name: 📚 Install required system packages
if: matrix.os == 'ubuntu-latest'
run: |
sudo apt update
sudo apt install xorg-dev libglu1-mesa-dev libgtk-3-dev
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Install LLVM (for OpenMP) on macOS
if: matrix.openmp == true && matrix.os == 'macos-latest'
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
brew install llvm
echo "$(brew --prefix llvm)/bin/" >> $GITHUB_PATH
- name: ⚙ Install LLVM and Ninja (for OpenMP) on Windows
if: matrix.openmp == true && matrix.os == 'windows-latest'
shell: pwsh
working-directory: ${{runner.workspace}}/build
run: |
choco install llvm ninja -y
"CMAKE_FLAGS=$env:CMAKE_FLAGS -G Ninja" >> $env:GITHUB_ENV
- name: ⚙ Configure with OpenMP
if: matrix.openmp == true && matrix.single-precision == false
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DSPIRIT_USE_OPENMP=ON $CMAKE_FLAGS
- name: ⚙ Configure with single-precision
if: matrix.openmp == false && matrix.single-precision == true
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DSPIRIT_SCALAR_TYPE="float" $CMAKE_FLAGS
- name: ⚙ Configure
if: matrix.openmp == false && matrix.single-precision == false
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config $BUILD_TYPE -j 2
- name: 📚 Install python packages
run: pip install --user numpy
- name: 🧪 Test
shell: bash
working-directory: ${{runner.workspace}}/build
run: ctest -C $BUILD_TYPE -E $EXCLUDETESTS --rerun-failed --output-on-failure
test-coverage:
runs-on: ubuntu-latest
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_UI_CXX_USE_QT=OFF -DSPIRIT_TEST_COVERAGE=ON
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config Release -j 2
- name: 📚 Install necessary packages
run: |
python -m pip install --upgrade pip
python -m pip install numpy coverage 'coveralls<3' wheel
sudo apt update
sudo apt install lcov
- name: 🧪 Generate C++ coverage
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
lcov -c -i --no-external --directory . --base-directory $GITHUB_WORKSPACE/core -o baseline.info
make test
lcov -c --no-external --directory . --base-directory $GITHUB_WORKSPACE/core -o after_test.info
lcov -a baseline.info -a after_test.info -o total_test.info
lcov -r total_test.info \*thirdparty\* \*/test/\* \*Collection\* \*DLL_\* -o coverage.info
- name: ⬆ Upload C++ coverage
uses: codecov/codecov-action@v1
with:
files: ${{runner.workspace}}/build/coverage.info
- name: 🧪 Python API coverage
working-directory: ./core/python
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
coverage run --source spirit --omit=spirit/spiritlib.py setup.py test > cov.txt
head cov.txt
coverage report -m
coverage xml
coveralls
test-pinning-defects:
runs-on: ubuntu-latest
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_UI_CXX_USE_QT=OFF -DSPIRIT_ENABLE_PINNING=ON -DSPIRIT_ENABLE_DEFECTS=ON
steps:
- uses: actions/checkout@v3
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config $BUILD_TYPE -j 2
- name: 📚 Install python packages
run: pip install --user numpy
- name: 🧪 Test
shell: bash
working-directory: ${{runner.workspace}}/build
run: ctest -C $BUILD_TYPE --output-on-failure
lint:
runs-on: ubuntu-20.04
strategy:
fail-fast: false
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=ON -DSPIRIT_UI_CXX_USE_QT=OFF -DSPIRIT_ENABLE_PINNING=ON -DSPIRIT_ENABLE_DEFECTS=ON
SOURCES: "find core/include/ core/src/ ui-cpp/utility/ ui-cpp/ui-imgui/include/ ui-cpp/ui-imgui/src/ -iname *.hpp -o -iname *.cpp"
steps:
- uses: actions/checkout@v3
- name: 📚 Install required system packages
run: |
wget --no-verbose -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
sudo add-apt-repository "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-15 main"
sudo apt update
sudo apt install xorg-dev libglu1-mesa-dev libgtk-3-dev clang-format-15 clang-tidy-15
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🧪 clang-format linting
if: always()
shell: bash
run: |
clang-format-15 --version
OUTPUT=$($SOURCES | xargs clang-format-15 -n 2>&1)
if [[ $OUTPUT ]]; then
echo "$OUTPUT"
exit 1
fi
- name: 🧪 clang-tidy linting
if: always()
shell: bash
run: |
clang-tidy-15 --version
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: 📚 Install python packages
run: pip install --user numpy pylint black
- name: 🧪 Python code formatting check
shell: bash
run: |
black core/python --check
black ui-python --check
- name: 🧪 Python code quality checks, linting
shell: bash
run: pylint core/python/spirit --fail-under=8
build-cuda:
runs-on: ${{ matrix.config.os }}
strategy:
fail-fast: false
matrix:
config:
- os: ubuntu-22.04
# - os: ubuntu-20.04 # does not seem to support CUDA C++17
# - os: ubuntu-18.04 # does not seem to support CUDA C++17
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_UI_CXX_USE_QT=OFF -DSPIRIT_USE_CUDA=ON -DSPIRIT_CUDA_ARCH=sm_70
steps:
- uses: actions/checkout@v3
- name: Force downgrade to gcc-10 on Ubuntu 22.04 to avoid a bug in gcc-11.3 header
if: matrix.config.os == 'ubuntu-22.04'
shell: bash
run: |
sudo apt-get --purge remove "g++*"
sudo apt install g++-10
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 10
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-10 10
- name: 📚 Install CUDA
shell: bash
run: |
sudo apt update
sudo apt install nvidia-cuda-toolkit
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config $BUILD_TYPE -j 2
build-ui-qt:
runs-on: ubuntu-18.04
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_UI_CXX_USE_QT=ON
steps:
- uses: actions/checkout@v3
- name: 📚 Install Qt5
run: |
sudo apt update
sudo apt install qt5-default libqt5charts5-dev
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config $BUILD_TYPE -j 2
webapp-mobile:
runs-on: ubuntu-20.04
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_BUILD_FOR_JS=ON
EMSCRIPTEN_VERSION: "1.39.20"
steps:
- uses: actions/checkout@v3
- name: 📚 Install Emscripten
working-directory: ${{runner.workspace}}
run: |
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install $EMSCRIPTEN_VERSION
./emsdk activate $EMSCRIPTEN_VERSION
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
source ${{runner.workspace}}/emsdk/emsdk_env.sh
cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS -DCMAKE_TOOLCHAIN_FILE=${{runner.workspace}}/emsdk/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
source ${{runner.workspace}}/emsdk/emsdk_env.sh
cmake --build . --config $BUILD_TYPE -j 2
- name: 📦 Archive mobile web app
uses: actions/upload-artifact@v2
with:
name: webapp-mobile
path: ui-web/
webapp-desktop:
runs-on: ubuntu-20.04
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=ON -DSPIRIT_BUILD_FOR_JS=ON
EMSCRIPTEN_VERSION: "1.39.20"
steps:
- uses: actions/checkout@v3
- name: 📚 Install Emscripten
working-directory: ${{runner.workspace}}
run: |
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install $EMSCRIPTEN_VERSION
./emsdk activate $EMSCRIPTEN_VERSION
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
source ${{runner.workspace}}/emsdk/emsdk_env.sh
cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS -DCMAKE_TOOLCHAIN_FILE=${{runner.workspace}}/emsdk/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
source ${{runner.workspace}}/emsdk/emsdk_env.sh
cmake --build . --config $BUILD_TYPE -j 2
- name: 📦 Archive desktop web app
uses: actions/upload-artifact@v2
with:
name: webapp-desktop
path: ui-cpp/ui-imgui/webapp/
deploy-pypi:
if: github.event_name != 'pull_request'
needs: [test, lint]
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=OFF -DSPIRIT_UI_CXX_USE_QT=OFF
SPIRIT_ADD_VERSION_SUFFIX: true
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: ⚙ Configure environment
shell: bash
if: github.ref == 'refs/heads/master'
run: echo "SPIRIT_ADD_VERSION_SUFFIX=false" >> $GITHUB_ENV
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake --build . --config $BUILD_TYPE -j 2
- name: 📚 Install necessary packages
run: |
python -m pip install --upgrade pip
python -m pip install numpy setuptools wheel twine
- name: 🛠 Build Python package
shell: bash
working-directory: ./core/python
run: |
echo "Python package build"
echo "Add suffix to spirit version tag for python package $SPIRIT_ADD_VERSION_SUFFIX"
python setup.py sdist bdist_wheel
- name: 🚀 Deploy to TestPyPI
working-directory: ./core/python
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
if: github.ref != 'refs/heads/master'
run: twine upload --skip-existing --repository testpypi dist/*
- name: 🚀 Deploy to PyPI
working-directory: ./core/python
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
if: github.ref == 'refs/heads/master'
run: twine upload --skip-existing dist/*
deploy-package:
if: github.event_name != 'pull_request'
needs: [test, lint]
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
env:
BUILD_TYPE: Release
CMAKE_FLAGS: -DSPIRIT_UI_USE_IMGUI=ON -DSPIRIT_UI_CXX_USE_QT=OFF -DSPIRIT_BUNDLE_APP=ON
steps:
- uses: actions/checkout@v3
- name: 📚 Install required system packages
if: matrix.os == 'ubuntu-latest'
run: |
sudo apt update
sudo apt install xorg-dev libglu1-mesa-dev libgtk-3-dev
- name: 📁 Create build folder
run: cmake -E make_directory ${{runner.workspace}}/build
- name: ⚙ Configure
shell: bash
working-directory: ${{runner.workspace}}/build
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE $CMAKE_FLAGS
- name: 🛠 Build
shell: bash
working-directory: ${{runner.workspace}}/build
run: |
cmake --build . --config $BUILD_TYPE -j 2
cmake --install .
cmake --build . --config $BUILD_TYPE -j 2 --target package
- name: 📦 Archive ubuntu package
if: matrix.os == 'ubuntu-latest'
uses: actions/upload-artifact@v2
with:
name: spirit-ubuntu
path: |
${{runner.workspace}}/build/*.tar.gz
- name: 📦 Archive macOS package
if: matrix.os == 'macos-latest'
uses: actions/upload-artifact@v2
with:
name: spirit-macos
path: |
${{runner.workspace}}/build/*.dmg
${{runner.workspace}}/build/install/README.md
${{runner.workspace}}/build/install/LICENSE.txt
${{runner.workspace}}/build/install/VERSION.txt
${{runner.workspace}}/build/install/licenses/
- name: 📦 Archive windows package
if: matrix.os == 'windows-latest'
uses: actions/upload-artifact@v2
with:
name: spirit-windows
path: |
${{runner.workspace}}/build/*.zip
draft-release:
if: github.event_name == 'push' && startsWith( github.ref, 'refs/tags/' )
needs: [test, lint, webapp-mobile, webapp-desktop, deploy-package]
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3
- name: 📄 Generate a changelog
id: changelog
uses: metcalfc/changelog-generator@v1.0.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
- name: 📄 Print the changelog
run: echo "${{ steps.changelog.outputs.changelog }}"
- name: 🎉 Create draft release
id: draft_release
uses: actions/create-release@v1
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
body: ${{ steps.changelog.outputs.changelog }}
draft: true