ci.yaml

on:
  push:
    branches:
      - main
  pull_request:
  merge_group:
  workflow_dispatch:

name: CI

# Cancel PR actions on new commits
concurrency:
  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
  cancel-in-progress: true

permissions: {}

jobs:
  test:
    name: Test
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, windows-latest, macOS-latest ]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Install Vulkan SDK
        uses: jakoch/install-vulkan-sdk-action@v1
        with:
          vulkan_version: 1.4.321.0
          install_runtime: true
          # cache restore on mac is broken
          # see https://github.com/jakoch/install-vulkan-sdk-action/issues/558
          cache: ${{ runner.os != 'macOS' }}
          stripdown: true
      - if: ${{ runner.os == 'Linux' }}
        name: Linux - Install native dependencies
        run: sudo apt install libwayland-cursor0 libxkbcommon-dev libwayland-dev
      # just need a random command that forces the installation of rust-toolchain
      # figure out native target triple while we're at it
      - name: install rust-toolchain
        run: echo "TARGET=$(rustc --print host-tuple)" >> "$GITHUB_ENV"
      - name: install nextest
        uses: taiki-e/install-action@nextest
      - uses: Swatinem/rust-cache@v2
        with:
          add-job-id-key: "false"
          shared-key: "base"
          save-if: ${{ github.ref_name == 'main' }}
      # Fetch dependencies in a separate step to clearly show how long each part
      # of the testing takes
      - name: cargo fetch --locked
        run: cargo fetch --locked --target $TARGET

      # Core crates
      # Compiled in --release because cargo compiletest would otherwise compile in release again.
      - name: rustc_codegen_spirv build
        run: cargo nextest run -p rustc_codegen_spirv --release --no-default-features --features "use-installed-tools" --no-run

      - name: rustc_codegen_spirv test
        run: cargo nextest run -p rustc_codegen_spirv --release --no-default-features --features "use-installed-tools"

      - name: workspace test (excluding examples)
        run: cargo nextest run --release --workspace --exclude "example-runner-*" --exclude "cargo-gpu*" --no-default-features --features "use-installed-tools,clap,bytemuck"

      # Examples
      - name: cargo check examples
        run: cargo check -p example-runner-ash -p example-runner-wgpu -p example-runner-cpu -p compute-shader -p mouse-shader -p simplest-shader -p sky-shader --no-default-features --features "use-installed-tools"

      - name: build example shaders
        env:
          PROFILE: release
          OUT_DIR: "target/release/ci/out"
        run: cargo run -p example-runner-wgpu-builder --release --no-default-features --features "use-installed-tools"

      - name: build example shaders (dev aka "debug mode")
        env:
          # HACK(eddyb) see `[profile.dev]` in `Cargo.toml` for more on why
          # `-Zshare-generics=off` is useful (and why it had to be moved here).
          RUSTFLAGS: -Zshare-generics=off
          PROFILE: debug
          OUT_DIR: "target/debug/ci/out"
        run: cargo run -p example-runner-wgpu-builder --no-default-features --features "use-installed-tools"

      # Our test runners select very different features for dependencies, so they need to be two separate builds.
      # * compiletests depends on `rustc_codegen_spirv` directly with features `use-installed-tools`
      # * difftests depends on `spirv-builder` with no features, which excludes `rustc_codegen_spirv` entirely.
      #   The individual difftest crates depend on it and run the spirv compile, never the test runner itself.
      - name: prep cache for other jobs
        if: github.ref_name == 'main'
        run: |
          cargo build -p compiletests --release --no-default-features --features "use-installed-tools"
          cargo build -p difftests --release --no-default-features --features "use-installed-tools"


  android:
    name: Android
    strategy:
      matrix:
        os: [ ubuntu-latest ]
        target: [ aarch64-linux-android ]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Install Vulkan SDK
        uses: jakoch/install-vulkan-sdk-action@v1
        with:
          vulkan_version: 1.4.321.0
          install_runtime: true
          cache: true
          stripdown: true
      - name: install rust-toolchain
        run: cargo version
      - uses: Swatinem/rust-cache@v2
        with:
          add-job-id-key: "false"
          shared-key: "android"
          save-if: ${{ github.ref_name == 'main' }}
      - name: cargo fetch --locked
        run: cargo fetch --locked --target ${{ matrix.target }}

      - name: Build WGPU Example for Android
        shell: bash
        run: |
          echo "::group::Uninstall android-31"
          $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --uninstall "platforms;android-31"
          echo "::endgroup::"

          echo "::group::Install android-30"
          $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --install "platforms;android-30"
          echo "::endgroup::"

          echo "::group::Install cargo-apk"
          cargo +stable install cargo-apk
          echo "::endgroup::"

          echo "::group::Add aarch64-linux-android target"
          rustup target add aarch64-linux-android
          echo "::endgroup::"

          echo "::group::Build WGPU example for Android"
          cargo apk build -p example-runner-wgpu --lib --features use-installed-tools --no-default-features
          echo "::endgroup::"

  compiletest:
    name: Compiletest
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, windows-latest, macOS-latest ]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Install Vulkan SDK
        uses: jakoch/install-vulkan-sdk-action@v1
        with:
          vulkan_version: 1.4.321.0
          install_runtime: true
          cache: true
          stripdown: true
      - name: install rust-toolchain
        run: echo "TARGET=$(rustc --print host-tuple)" >> "$GITHUB_ENV"
      - uses: Swatinem/rust-cache@v2
        with:
          add-job-id-key: "false"
          shared-key: "base"
          save-if: "false"
      - name: cargo fetch --locked
        run: cargo fetch --locked --target $TARGET
      - name: build compiletest
        run: cargo build -p compiletests --release --no-default-features --features "use-installed-tools"
      - name: compiletest vulkan1.1
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.1
      - name: compiletest vulkan1.2
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.2
      - name: compiletest vulkan1.3
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.3
      - name: compiletest vulkan1.4
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env vulkan1.4
      - name: compiletest spv1.3
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env spv1.3
      - name: compiletest spv1.4
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env spv1.4
      - name: compiletest spv1.5
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env spv1.5
      - name: compiletest spv1.6
        run: cargo run -p compiletests --release --no-default-features --features "use-installed-tools" -- --target-env spv1.6

  difftest:
    name: Difftest
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, windows-latest, macOS-latest ]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Install Vulkan SDK
        uses: jakoch/install-vulkan-sdk-action@v1
        with:
          vulkan_version: 1.4.321.0
          install_runtime: true
          cache: true
          stripdown: true
          install_lavapipe: true
          github_token: ${{ secrets.GITHUB_TOKEN }}
      - if: ${{ runner.os == 'Linux' }}
        name: Linux - Install native dependencies
        run: sudo apt install libwayland-cursor0 libxkbcommon-dev libwayland-dev
      - if: ${{ runner.os == 'Linux' }}
        name: Install xvfb, llvmpipe and lavapipe
        run: |
          sudo apt-get update -y -qq
          sudo add-apt-repository ppa:kisak/turtle -y
          sudo apt-get update
          sudo apt install -y xvfb libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
      - name: install rust-toolchain
        run: echo "TARGET=$(rustc --print host-tuple)" >> "$GITHUB_ENV"
      - name: install nextest
        uses: taiki-e/install-action@nextest
      - uses: Swatinem/rust-cache@v2
        with:
          add-job-id-key: "false"
          shared-key: "base"
          save-if: "false"
      - uses: Swatinem/rust-cache@v2
        with:
          add-job-id-key: "false"
          shared-key: "difftest"
          workspaces: "tests/difftests/tests"
      - name: cargo fetch --locked
        run: cargo fetch --locked --target $TARGET
      - name: cargo fetch --locked difftests
        run: cargo fetch --locked --manifest-path=tests/difftests/tests/Cargo.toml --target $TARGET
      - name: build difftests (without shaders)
        run: cargo nextest run -P difftests -p difftests --release --no-default-features --features "use-installed-tools" --no-run
      - name: difftests
        run: cargo nextest run -P difftests -p difftests --release --no-default-features --features "use-installed-tools"

  cargo-gpu-os:
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    env:
      RUST_LOG: debug
    steps:
      - uses: actions/checkout@v6
      - uses: taiki-e/install-action@v2
        with:
          tool: nextest
      - run: cargo fetch --locked
      - name: shader-crate-template cargo fetch --locked
        run: |
          cd ./crates/shader-crate-template
          cargo fetch --locked
      - run: cargo nextest run -p cargo-gpu -p cargo-gpu-install
      - name: Run a full build
        run: cargo xtask test-build

  cargo-gpu-backwards-compat:
    # The dependency is technically unnecessary, this is just to delay the launch of this job, so that github prefers
    # launching long-running jobs first. Currently, these jobs take only about 7min compared to 22min of others.
    needs: [cargo-deny]
    strategy:
      fail-fast: false
      matrix:
        include:
          # As well as testing on each OS, we also want to test to make sure we're still supporting
          # older versions of `rust-gpu`. However, we can assume that these tests are already okay
          # across platforms, so we only need to test on Linux, the chepeast in terms of minutes.
          #
          # `0.7.0` currently fails building `spirv-builder-cli` with:
          #    """
          #    package `is_terminal_polyfill v1.70.1` cannot be built because it requires rustc
          #    1.70.0 or newer, while the currently active rustc version is 1.69.0-nightly
          #    """
          # It's probably easily fixable. But also `0.7.0` was released in April 2023, so there's
          # unlikely many users of it?

          # 0.8.0 started failing as well due to `zmij v1.0.20` requiring rustc 1.71 or newer
          #          - rust-gpu-version: 0.8.0
          #            glam-version: 0.24.2
          # 0.9.0 started failing due to `jobserver v0.1.35` requiring rustc 1.85 or newer
          #          - rust-gpu-version: 0.9.0
          #            glam-version: 0.24.2

          # target spec introduction
          # last version before
          # * fails: compiler too old, `serde` using `#[diagnostic]`
          #          - rust-gpu-version: cc752312c3de6813a41189e46476d5c1be5e0bbe
          #            glam-version: 0.30.7
          # first version requiring target specs
          # * fails: target spec mismatch!
          # * resolution: Since this is just a few commits, I'd be fine ignoring it.
          #          - rust-gpu-version: 02cefd101014f66b79dffb20a2c2b5b7c9038401
          #            glam-version: 0.30.7
          # target specs change again just a few commits later
          # * fails: compiler too old, `proc-macro2` using `Literal::byte_character`.
          # * resolution: want to support, can't be bothered to hack in old proc-macro2 versions
          #          - rust-gpu-version: bbb61f58b3d24f3f64745050eb214b90bf6dcce9
          #            glam-version: 0.30.7

          # also started failing due to `jobserver v0.1.35` requiring rustc 1.85 or newer
          # testing rustc 1.79.0, 1.5 months later
          #          - rust-gpu-version: eea8998df9dc2fd8e7a65c5b5b7ae20c238a665a
          #            glam-version: 0.29.3

          # just after target specs v2 refactor, we updated to rustc 1.85 and needed to change them again
          # before
          # * fails: indexmap-2.14.0 requires edition 2024, not yet stabilized on this toolchain
          # - rust-gpu-version: a547c6e45266d613d9fec673e869d7a96181e47b
          #   glam-version: =0.30.7
          # after
          - rust-gpu-version: 2326b87fe1542eeb898065e36ac949307b55386d
            glam-version: =0.30.7

          # glam semver breakage due to vector type refactor
          # before, glam was fixed to <=0.30.7 in this commit
          - rust-gpu-version: f79c4181a5dc2d37303947b113f190930c6c1ce6
            glam-version: =0.30.7
          # after, glam >0.30.8
          - rust-gpu-version: e767f24f2565baf1a71bbaf84d453d181cab2417

          # rustc 1.94.0 destabilised json target specs, requiring `-Ztarget-spec-json`
          # see https://github.com/Rust-GPU/rust-gpu/pull/545
          # see https://github.com/rust-lang/rust/pull/150151
          # before
          - rust-gpu-version: 30896871ba00e668029ccb724f1438202b284708
          # after
          - rust-gpu-version: 877bd8697a15f3e6d09446a5e1807e6237ca1dac

          # rustc 1.97.0 removed "allows-weak-linkage" key
          # before
          - rust-gpu-version: a27c0363d391a54de1feb9ee6864ad9dff72d243
            glam-version: 0.33.0
          # after to be added later
    runs-on: ubuntu-latest
    env:
      RUST_LOG: debug
    steps:
      - uses: actions/checkout@v6
      - if: ${{ matrix.glam-version }}
        name: set glam version
        run: cargo xtask set-dependency glam ${{ matrix.glam-version }}
      - name: Run a full build
        run: cargo xtask test-build --rust-gpu-version ${{ matrix.rust-gpu-version }}

  release-dry-run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: install rust-toolchain
        run: echo "TARGET=$(rustc --print host-tuple)" >> "$GITHUB_ENV"
      - name: cargo fetch --locked
        run: cargo fetch --locked --target $TARGET
      - run: cargo publish --dry-run

  # This allows us to have a single job we can branch protect on, rather than needing
  # to update the branch protection rules when the test matrix changes
  test_success:
    runs-on: ubuntu-latest
    needs: [test, compiletest, difftest, android, lint, cargo-deny, release-dry-run, cargo-gpu-os, cargo-gpu-backwards-compat]
    # Hack for buggy GitHub Actions behavior with skipped checks: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks#handling-skipped-but-required-checks
    if: ${{ always() }}
    steps:
      # Another hack is to actually check the status of the dependencies or else it'll fall through
      - run: |
          echo "Checking statuses..."
          [[ "${{ needs.test.result }}" == "success" ]] || exit 1
          [[ "${{ needs.compiletest.result }}" == "success" ]] || exit 1
          [[ "${{ needs.difftest.result }}" == "success" ]] || exit 1
          [[ "${{ needs.android.result }}" == "success" ]] || exit 1
          [[ "${{ needs.lint.result }}" == "success" ]] || exit 1
          [[ "${{ needs.cargo-deny.result }}" == "success" ]] || exit 1
          [[ "${{ needs.release-dry-run.result }}" == "success" ]] || exit 1
          [[ "${{ needs.cargo-gpu-os.result }}" == "success" ]] || exit 1
          [[ "${{ needs.cargo-gpu-backwards-compat.result }}" == "success" ]] || exit 1

  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      # Note that we are explicitly NOT checking out submodules, to validate
      # that we haven't accidentally enabled spirv-tools native compilation
      # and regressed CI times
      - uses: actions/checkout@v6
        with:
          submodules: "false"
      - name: Install native dependencies
        run: sudo apt install libwayland-cursor0 libxkbcommon-dev libwayland-dev
      - name: Install Vulkan SDK
        uses: jakoch/install-vulkan-sdk-action@v1
        with:
          vulkan_version: 1.4.321.0
          install_runtime: true
          cache: true
          stripdown: true
      # cargo version is a random command that forces the installation of rust-toolchain
      - name: install rust-toolchain
        run: cargo version
      - name: Install rustup components
        run: rustup component add rustfmt clippy
      - name: cargo fetch --locked
        run: cargo fetch --locked
      - name: Rustfmt
        run: cargo fmt --all -- --check
      - name: Rustfmt compiletests
        run: shopt -s globstar && rustfmt --check tests/compiletests/ui/**/*.rs
      - name: Rustfmt difftests
        run: cargo fmt --check --all --manifest-path tests/difftests/tests/Cargo.toml
      - name: Check docs are valid
        run: RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps
      - name: Check docs for `spirv-std` and `spirv-builder` on stable (for docs.rs)
        run: |
          RUSTDOCFLAGS=-Dwarnings cargo +stable doc --no-deps -p spirv-std
          RUSTDOCFLAGS=-Dwarnings cargo +stable doc --no-deps -p spirv-builder --no-default-features
      - name: cargo clippy
        run: cargo clippy --all-targets -- -D warnings
      - name: custom lints
        run: .github/workflows/lint.sh

  cargo-deny:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: EmbarkStudios/cargo-deny-action@v2

defaults:
  run:
    shell: bash