Add a note about context. #20
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: CI | |
| on: | |
| push: | |
| paths-ignore: | |
| - "LICENSE" | |
| - "README.md" | |
| pull_request: | |
| paths-ignore: | |
| - "LICENSE" | |
| - "README.md" | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| # If true, cancel the workflow run if any matrix job fails. | |
| # If false, continue to run the workflow and complete all matrix jobs, even if one or more jobs fail. | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - os: macos-latest | |
| build_type: Release | |
| # c_compiler: clang | |
| cpp_compiler: clang++ | |
| - os: ubuntu-latest | |
| build_type: Release | |
| # c_compiler: gcc | |
| cpp_compiler: g++ | |
| - os: windows-latest | |
| build_type: Release | |
| # c_compiler: cl | |
| cpp_compiler: cl | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - 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" | |
| echo "deps-dir=${{ github.workspace }}/deps" >> "$GITHUB_OUTPUT" | |
| - name: Cache CMake deps directory | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.strings.outputs.deps-dir }} | |
| key: ${{ runner.os }}-deps-${{ hashFiles('CMakeLists.txt') }}-${{ hashFiles('cmake/**') }} | |
| restore-keys: | | |
| ${{ runner.os }}-deps- | |
| - name: Install GNU/Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: sudo apt-get update && sudo apt-get install libxrandr-dev libxcursor-dev libudev-dev libopenal-dev libflac-dev libvorbis-dev libgl1-mesa-dev libegl1-mesa-dev | |
| - name: 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 | |
| # Set "-DCMAKE_C_COMPILER=${{ matrix.c_compiler }}" for C/C++ projects, otherwise use CXX for C++ only projects. | |
| run: > | |
| cmake -B ${{ steps.strings.outputs.build-output-dir }} | |
| -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }} | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} | |
| -DBUILD_TESTS=ON | |
| -S ${{ github.workspace }} | |
| - name: 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: 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 }} --verbose --output-on-failure |