CI task to build documentation #29
This file contains hidden or 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
| name: Build and Test | |
| on: [push, pull_request] | |
| jobs: | |
| check-format: | |
| name: Check Formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - &checkout | |
| name: Checkout | |
| uses: actions/checkout@v4 | |
| - &get-uv | |
| name: Get UV | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| version: 0.8.15 | |
| - name: Check Formatting | |
| run: uv run --group=format --isolated make format-check | |
| build-docs: | |
| name: Build Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - *checkout | |
| - *get-uv | |
| - name: Build Documentation | |
| run: uv run --group=docs --isolated make docs-html | |
| # XXX: NOTE: The following are used to validate the content of our "ref/platform-support" | |
| # page. Any changes here should be reflected in the platform support page. | |
| build-matrix: | |
| name: Build & Test (Linux) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| env: | |
| # Alpine | |
| - alpine:3.17 | |
| - alpine:3.18 | |
| - alpine:3.19 | |
| - alpine:3.20 | |
| - alpine:3.21 | |
| - alpine:3.22 | |
| - alpine:latest | |
| - alpine:edge | |
| # Ubuntu | |
| - ubuntu:24.04 | |
| - ubuntu:latest | |
| # Debian | |
| - debian:12.11 | |
| - debian:latest | |
| - debian:unstable | |
| # Fedora | |
| - fedora:40 | |
| - fedora:41 | |
| - fedora:42 | |
| - fedora:43 | |
| - fedora:latest | |
| - fedora:rawhide | |
| # GCC versions | |
| - gcc:15.2.0 | |
| - gcc:14.3.0 | |
| - gcc:13.4.0 | |
| - gcc:12.5.0 | |
| - gcc:latest | |
| # Clang versions | |
| - +env.llvm --llvm_major_version=17 | |
| - +env.llvm --llvm_major_version=18 | |
| - +env.llvm --llvm_major_version=19 | |
| - +env.llvm --llvm_major_version=20 | |
| vcpkg_arg: &vcpkg_arg | |
| - use_vcpkg=false | |
| - use_vcpkg=true | |
| exclude: | |
| # Older Alpine requires using vcpkg: | |
| - { env: alpine:3.17, vcpkg_arg: use_vcpkg=false } | |
| include: | |
| # Add Almalinux (RHEL) targets, alwasy using vcpkg | |
| - { env: almalinux:10, vcpkg_arg: use_vcpkg=true } | |
| # RHEL ≤9 requires a newer GCC, using the GCC toolset: | |
| - { env: almalinux:9 --gts_version=14, vcpkg_arg: use_vcpkg=true } | |
| - { env: almalinux:9 --gts_version=13, vcpkg_arg: use_vcpkg=true } | |
| - { env: almalinux:9 --gts_version=12, vcpkg_arg: use_vcpkg=true } | |
| # RHEL 8 | |
| - { env: almalinux:8 --gts_version=13, vcpkg_arg: use_vcpkg=true } | |
| - { env: almalinux:8 --gts_version=12, vcpkg_arg: use_vcpkg=true } | |
| steps: | |
| - *checkout | |
| - name: Environment Prep | |
| run: | | |
| bash tools/earthly.sh +init \ | |
| --env=${{matrix.env}} \ | |
| --${{matrix.vcpkg_arg}} | |
| - name: Build | |
| run: | | |
| bash tools/earthly.sh +build \ | |
| --env=${{matrix.env}} \ | |
| --${{matrix.vcpkg_arg}} | |
| # This step will use the same cached +build results as long as all Earthly | |
| # build arguments are equivalent. Make sure of that! | |
| - name: Test | |
| run: | | |
| bash tools/earthly.sh -a +test/results.xml results.xml \ | |
| --env=${{matrix.env}} \ | |
| --${{matrix.vcpkg_arg}} | |
| build-windows: | |
| name: Build & Test (Windows, VS 2022) | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| arch: [x86, amd64, arm64] | |
| runs-on: windows-2022 | |
| steps: | |
| - *checkout | |
| - name: Prepare Caches | |
| uses: actions/cache@v4 | |
| with: | |
| path: _build/_cache | |
| key: msvc-${{matrix.arch}} | |
| # This step only warms up the uv cache for the `build` group used by the | |
| # main build process | |
| - name: Prepare uv Environment | |
| shell: pwsh | |
| run: | | |
| Import-Module ./tools/uv | |
| [void](Get-UvEnvironment "--group=build") | |
| - name: Build & Test | |
| shell: pwsh | |
| # 17.* selects VS 2022 | |
| run: | | |
| tools/ci.ps1 -VSVersion 17.* -TargetArch ${{matrix.arch}} -UseVcpkg -BuildTesting |