Github Workflows: setup python CI #47
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 starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform. | |
| # See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml | |
| name: CMake on multiple platforms | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| concurrency: | |
| group: ${{ github.repository }}-${{ github.event.number || github.head_ref || github.sha }}-${{ github.workflow }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable. | |
| fail-fast: false | |
| # Set up a matrix to run the following 3 configurations: | |
| # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator> | |
| # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator> | |
| # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator> | |
| # | |
| # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list. | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| build_type: [RelWithDebInfo] | |
| c_compiler: [clang, cl] | |
| include: | |
| - os: windows-latest | |
| c_compiler: cl | |
| cpp_compiler: cl | |
| - os: ubuntu-latest | |
| c_compiler: clang | |
| cpp_compiler: clang++ | |
| - os: macos-latest | |
| c_compiler: clang | |
| cpp_compiler: clang++ | |
| exclude: | |
| - os: windows-latest | |
| c_compiler: gcc | |
| - os: windows-latest | |
| c_compiler: clang | |
| - os: ubuntu-latest | |
| c_compiler: cl | |
| - os: ubuntu-latest | |
| c_compiler: gcc | |
| - os: macos-latest | |
| c_compiler: gcc | |
| - os: macos-latest | |
| c_compiler: cl | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "[C++] Ccache for gh actions" | |
| uses: hendrikmuhs/[email protected] | |
| with: | |
| key: ${{ github.job }}-${{ matrix.os }} # Eg. "some_build-ubuntu-latest" | |
| - name: "Set reusable strings" | |
| # Turn repeated input strings (such as the build output directory) into step outputs. | |
| # These step outputs can be used throughout the workflow file. | |
| id: strings | |
| shell: bash | |
| run: | | |
| echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT" | |
| - name: "[C++] Cache CMake dependency source code" | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-cmake-dependency-sources | |
| with: | |
| # CMake cache is at ${{github.workspace}}/build/_deps but we only will cache folders ending in '-src' to cache source code | |
| path: ${{github.workspace}}/build/_deps/*-src | |
| # Cache hash is dependent on CMakeLists files anywhere as these can change what's in the cache, as well as cmake modules files | |
| key: ${{ env.cache-name }}-${{ hashFiles('**/CMakeLists.txt', 'cmake/**') }} | |
| # it's acceptable to reuse caches for different CMakeLists content if exact match is not available and unlike build caches, we | |
| # don't need to restrict these by OS or compiler as it's only source code that's being cached | |
| restore-keys: | | |
| ${{ env.cache-name }}- | |
| - name: "[C++] Cache CMake dependency build objects" | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-cmake-dependency-builds | |
| with: | |
| # CMake cache is at ${{github.workspace}}/build/_deps but we only care about the folders ending in -build or -subbuild | |
| path: | | |
| ${{github.workspace}}/build/_deps/*-build | |
| ${{github.workspace}}/build/_deps/*-subbuild | |
| # Cache hash is dependent on CMakeLists files anywhere as these can change what's in the cache, as well as cmake modules files | |
| key: ${{ env.cache-name }}-${{ matrix.os }}-${{ matrix.cxx }}-${{ hashFiles('**/CMakeLists.txt', 'cmake/**') }} | |
| # it's acceptable to reuse caches for different CMakeLists content if exact match is not available | |
| # as long as the OS and Compiler match exactly | |
| restore-keys: | | |
| ${{ env.cache-name }}-${{ matrix.os }}-${{ matrix.cxx }}- | |
| - name: "[C++] Configure CMake" | |
| # Configure CMake in a 'build' subdirectory. | |
| # `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. | |
| # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type | |
| run: > | |
| cmake | |
| -B ${{ steps.strings.outputs.build-output-dir }} | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} | |
| -DCMAKE_C_COMPILER=${{ matrix.c_compiler }} | |
| -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }} | |
| -DCMAKE_C_COMPILER_LAUNCHER=ccache | |
| -DCMAKE_CXX_COMPILER_LAUNCHER=ccache | |
| -S ${{ github.workspace }} | |
| - name: "[C++] Build" | |
| # Build your program with the given configuration. | |
| # Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator). | |
| run: > | |
| cmake | |
| --build ${{ steps.strings.outputs.build-output-dir }} | |
| --config ${{ matrix.build_type }} | |
| - name: "[C++] Test" | |
| working-directory: ${{ steps.strings.outputs.build-output-dir }} | |
| # Execute tests defined by the CMake configuration. | |
| # Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator). | |
| # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail | |
| run: ctest --build-config ${{ matrix.build_type }} | |
| # - name: "[C++] Save listing of build dir" | |
| # run: find ${{github.workspace}}/build > ${{github.workspace}}/build/path_listing.txt | |
| # - name: "[C++] Store Build Products" | |
| # uses: actions/upload-artifact@v4 | |
| # with: | |
| # name: ${{ github.job }}-${{ matrix.os }}_paths | |
| # path: ${{github.workspace}}/build/path_listing.txt | |
| - name: "[C++] Generate PB Tech (Windows)" | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| run: build\${{matrix.build_type}}\gen_tech_pb.exe | |
| working-directory: ${{github.workspace}} | |
| - name: "[C++] Generate PB Tech (Unix)" | |
| if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' }} | |
| run: build/gen_tech_pb | |
| working-directory: ${{github.workspace}} | |
| - name: "[C++] Store Build Products" | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ github.job }}-${{ matrix.os }} # -${{ matrix.build_type }} | |
| # Generated Python Protobuffer Classes | |
| # KPEX Tech Info Protobuffers | |
| path: | | |
| ${{github.workspace}}/build/python_kpex_protobuf/ | |
| ${{github.workspace}}/build/*_tech.pb.json | |
| if-no-files-found: error | |
| test: | |
| needs: build | |
| strategy: | |
| # fail-fast: true | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| python-version: ['3.13'] | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| ALLURE_RESULTS_PATH: 'build/${{ matrix.os }}_${{ matrix.python-version }}/allure-results' | |
| ALLURE_REPORTS_PATH: 'build/${{ matrix.os }}_${{ matrix.python-version }}/allure-reports' | |
| COVERAGE_REPORT_PATH: 'build/${{ matrix.os }}_${{ matrix.python-version }}/python-coverage-report' | |
| PYTHONPATH: .:build/python:$PYTHONPATH | |
| steps: | |
| - name: "[Python] checkout repository" | |
| uses: actions/checkout@v4 | |
| - name: "[Python] Retrieve C++ Build Artifact" | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: build-${{ matrix.os }} | |
| - name: "[Python] Setup python ${{ matrix.python-version }}" | |
| id: setup-python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| #---------------------------------------------- | |
| # ----- install & configure poetry ----- | |
| #---------------------------------------------- | |
| - name: "[Python] Install Poetry" | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| virtualenvs-path: .venv | |
| installer-parallel: true | |
| #---------------------------------------------- | |
| # load cached venv if cache exists | |
| #---------------------------------------------- | |
| - name: "[Python] Load cached venv" | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} | |
| #---------------------------------------------- | |
| # install dependencies if cache does not exist | |
| #---------------------------------------------- | |
| - name: "[Python] Install dependencies" | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: poetry install --no-interaction --no-root | |
| #---------------------------------------------- | |
| # install your root project, if required | |
| #---------------------------------------------- | |
| - name: "[Python] Install project" | |
| run: poetry install --no-interaction | |
| #---------------------------------------------- | |
| # run test suite | |
| #---------------------------------------------- | |
| - name: "[Python] Run tests" | |
| run: > | |
| poetry run pytest | |
| --alluredir $ALLURE_RESULTS_PATH | |
| --color no | |
| --cov $COVERAGE_REPORT_PATH | |
| --cov-report html | |
| - name: "[Python] Create coverage report" | |
| run: poetry run coverage report | |
| - name: "[Python] Store coverage results" | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: python-coverage-report | |
| path: $COVERAGE_REPORT_PATH | |
| retention-days: 1 | |
| - name: "Set up JDK (for Allure)" | |
| uses: actions/setup-java@v3 | |
| with: | |
| distribution: zulu | |
| java-version: 17 | |
| - name: "Load test report history (Allure)" | |
| uses: actions/checkout@v4 | |
| if: always() | |
| continue-on-error: true | |
| with: | |
| ref: gh-pages | |
| path: gh-pages | |
| - name: "Build test report" | |
| uses: simple-elf/[email protected] | |
| if: always() | |
| with: | |
| gh_pages: gh-pages | |
| allure_history: allure-history | |
| allure_results: build/allure-results | |
| - name: "Publish test report" | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: always() | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: allure-history |