implemented typedoc documentation #2539
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This is a basic workflow to help you get started with Actions | |
| name: CI | |
| # Controls when the action will run. Triggers the workflow on push or pull request | |
| # events but only for the master branch | |
| on: | |
| push: | |
| branches: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| jobs: | |
| build: | |
| name: CrossSection:${{matrix.cross_section}} ${{matrix.parallel_backend == 'TBB' && 'TBB' || ''}} GCC ${{matrix.gcc}} | |
| timeout-minutes: 45 | |
| strategy: | |
| matrix: | |
| cross_section: [ON] | |
| parallel_backend: [NONE, TBB] | |
| gcc: [13, 14] | |
| include: | |
| - cross_section: OFF | |
| parallel_backend: TBB | |
| gcc: 14 | |
| runs-on: ubuntu-24.04 | |
| env: | |
| CC: gcc-${{ matrix.gcc }} | |
| CXX: g++-${{ matrix.gcc }} | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install libglm-dev libgtest-dev libassimp-dev git libtbb-dev libthrust-dev pkg-config libpython3-dev lcov | |
| python -m pip install -U trimesh pytest | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: jwlawson/actions-setup-cmake@v2 | |
| - name: Build ${{matrix.parallel_backend}} | |
| if: matrix.parallel_backend != 'NONE' | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DMANIFOLD_PYBIND=ON -DMANIFOLD_DEBUG=ON -DMANIFOLD_FLAGS=-UNDEBUG -DMANIFOLD_CROSS_SECTION=${{matrix.cross_section}} -DMANIFOLD_EXPORT=ON -DMANIFOLD_PAR=${{matrix.parallel_backend}} .. && make | |
| - name: Test ${{matrix.parallel_backend}} | |
| if: matrix.parallel_backend != 'NONE' | |
| run: | | |
| cd build/test | |
| ./manifold_test | |
| - name: Test Python bindings ${{matrix.parallel_backend}} | |
| if: matrix.parallel_backend != 'NONE' && matrix.cross_section == 'ON' | |
| run: | | |
| export PYTHONPATH=$PYTHONPATH:$(pwd)/build/bindings/python | |
| python3 bindings/python/examples/run_all.py -e | |
| python3 -m pytest | |
| - name: Coverage Report | |
| # only do code coverage for default sequential backend, it seems that TBB | |
| # backend will cause failure | |
| # perhaps issue related to invalid memory access? | |
| if: matrix.parallel_backend == 'NONE' | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DMANIFOLD_PAR=${{matrix.parallel_backend}} -DCODE_COVERAGE=ON .. && make | |
| lcov --capture --gcov-tool gcov-${{ matrix.gcc }} --ignore-errors mismatch --initial --directory . --output-file ./code_coverage_init.info | |
| cd test | |
| ./manifold_test | |
| cd ../ | |
| lcov --capture --gcov-tool gcov-${{ matrix.gcc }} --ignore-errors mismatch --directory . --output-file ./code_coverage_test.info | |
| lcov --add-tracefile ./code_coverage_init.info --add-tracefile ./code_coverage_test.info --output-file ./code_coverage_total.info | |
| lcov --remove ./code_coverage_total.info '/usr/*' '*/test/*' '*/extras/*' '*/bindings/*' --output-file ./code_coverage.info | |
| cd ../ | |
| - uses: codecov/codecov-action@v4 | |
| if: matrix.parallel_backend == 'NONE' | |
| with: | |
| files: build/code_coverage.info | |
| fail_ci_if_error: false | |
| name: ${{matrix.parallel_backend}} | |
| - name: test cmake consumer | |
| run: | | |
| cd build | |
| sudo cmake --install . | |
| cd .. | |
| ./test-cmake.sh | |
| build_cbind: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-22.04 | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get -y update | |
| DEBIAN_FRONTEND=noninteractive sudo apt install -y libgtest-dev libglm-dev libassimp-dev git libtbb-dev pkg-config libpython3-dev python3 python3-distutils python3-pip | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: jwlawson/actions-setup-cmake@v2 | |
| - name: Build C bindings with TBB | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DMANIFOLD_PYBIND=ON -DMANIFOLD_DEBUG=ON -DMANIFOLD_CBIND=ON -DMANIFOLD_PAR=TBB .. && make | |
| - name: Test | |
| run: | | |
| cd build/test | |
| ./manifold_test --gtest_filter=CBIND.* | |
| build_wasm: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-22.04 | |
| if: github.event.pull_request.draft == false | |
| strategy: | |
| matrix: | |
| exception: [ON, OFF] | |
| steps: | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get -y update | |
| DEBIAN_FRONTEND=noninteractive sudo apt install -y nodejs libglm-dev | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Setup WASM | |
| run: | | |
| # setup emscripten | |
| git clone https://github.com/emscripten-core/emsdk.git | |
| cd emsdk | |
| ./emsdk install 3.1.61 | |
| ./emsdk activate 3.1.61 | |
| - uses: jwlawson/actions-setup-cmake@v2 | |
| - name: Build WASM | |
| run: | | |
| source ./emsdk/emsdk_env.sh | |
| mkdir build | |
| cd build | |
| emcmake cmake -DCMAKE_BUILD_TYPE=Release -DMANIFOLD_EXCEPTIONS=${{matrix.exception}} .. && emmake make | |
| - name: Test WASM | |
| run: | | |
| cd build/test | |
| node ./manifold_test.js | |
| - name: Test examples | |
| run: | | |
| cd bindings/wasm/examples | |
| npm ci | |
| npm run build | |
| npm test | |
| cp ../manifold.* ./dist/ | |
| - name: Upload WASM files | |
| uses: actions/upload-artifact@v4 | |
| if: matrix.exception == 'ON' | |
| with: | |
| name: wasm | |
| path: bindings/wasm/examples/dist/ | |
| retention-days: 90 | |
| overwrite: true | |
| build_windows: | |
| timeout-minutes: 30 | |
| strategy: | |
| matrix: | |
| parallel_backend: [NONE, TBB] | |
| max-parallel: 1 | |
| runs-on: windows-2019 | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: jwlawson/actions-setup-cmake@v2 | |
| - uses: ilammy/msvc-dev-cmd@v1 | |
| - name: Build ${{matrix.parallel_backend}} | |
| shell: powershell | |
| run: | | |
| cmake . -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DMANIFOLD_DEBUG=ON -DMANIFOLD_PAR=${{matrix.parallel_backend}} -A x64 -B build | |
| cd build | |
| cmake --build . --target ALL_BUILD --config Release | |
| - name: Test ${{matrix.parallel_backend}} | |
| shell: bash | |
| run: | | |
| cd build/bin/Release | |
| ./manifold_test.exe | |
| cd ../../ | |
| - name: test cmake consumer | |
| run: | | |
| cd build | |
| cmake --install . | |
| cd .. | |
| ./test-cmake.sh | |
| build_mxe: | |
| timeout-minutes: 30 | |
| strategy: | |
| matrix: | |
| parallel_backend: [NONE, TBB] | |
| max-parallel: 1 | |
| runs-on: ubuntu-latest | |
| container: openscad/mxe-x86_64-gui:latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Build | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DMANIFOLD_PYBIND=OFF -DMANIFOLD_DEBUG=ON -DMANIFOLD_PAR=${{matrix.parallel_backend}} .. && make | |
| - name: Test | |
| run: | | |
| cd build/test | |
| ./manifold_test | |
| build_mac: | |
| timeout-minutes: 30 | |
| strategy: | |
| matrix: | |
| parallel_backend: [NONE, TBB] | |
| runs-on: macos-latest | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - name: Install common dependencies | |
| run: | | |
| brew install pkg-config googletest assimp | |
| pip install trimesh pytest | |
| - name: Install TBB | |
| if: matrix.parallel_backend == 'TBB' | |
| run: brew install tbb onedpl | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: jwlawson/actions-setup-cmake@v2 | |
| - name: Build | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DMANIFOLD_DEBUG=ON -DMANIFOLD_PYBIND=ON -DMANIFOLD_EXPORT=ON -DMANIFOLD_PAR=${{matrix.parallel_backend}} .. && make | |
| - name: Test | |
| run: | | |
| cd build/test | |
| ./manifold_test | |
| cd ../../ | |
| - name: test cmake consumer | |
| run: | | |
| cd build | |
| sudo cmake --install . | |
| cd .. | |
| ./test-cmake.sh | |
| build_nix: | |
| timeout-minutes: 30 | |
| strategy: | |
| matrix: | |
| variant: [none, tbb, js] | |
| runs-on: ubuntu-latest | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: cachix/install-nix-action@v22 | |
| - run: nix build -L '.?submodules=1#manifold-${{matrix.variant}}' | |
| build_nix_python: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: cachix/install-nix-action@v22 | |
| - run: nix build -L '.?submodules=1#manifold3d' |