build.yml

name: Build and Lint
on:
  schedule:
    # runs every monday at midnight
    - cron: "0 0 * * 1"
  push:
    branches:
      - master
  pull_request:
env:
  RUST_CACHE_PREFIX: "v0-rust"

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    env:
      clang: "17"
      php_version: "8.3"
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Check typos
        uses: crate-ci/typos@master
      - name: Validate commit messages
        run: |
          git show-ref
          curl -sSfL https://github.com/convco/convco/releases/latest/download/convco-ubuntu.zip | zcat > convco
          chmod +x convco
          ./convco check refs/remotes/origin/master..HEAD
          rm convco
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ env.php_version }}
        env:
          debug: true
      - name: Setup Rust
        uses: dtolnay/rust-toolchain@master
        with:
          components: rustfmt, clippy
          toolchain: stable
      - name: Cache cargo dependencies
        uses: Swatinem/rust-cache@v2
        with:
          # increment this manually to force cache eviction
          prefix-key: ${{ env.RUST_CACHE_PREFIX }}
      - name: Cache LLVM and Clang
        id: cache-llvm
        uses: actions/cache@v3
        with:
          path: ${{ runner.temp }}/llvm-${{ env.clang }}
          key: ubuntu-latest-llvm-${{ env.clang }}
      - name: Setup LLVM & Clang
        id: clang
        uses: KyleMayes/install-llvm-action@v2
        with:
          version: ${{ env.clang }}
          directory: ${{ runner.temp }}/llvm-${{ env.clang }}
      - name: Configure Clang
        run: |
          echo "LIBCLANG_PATH=${{ runner.temp }}/llvm-${{ env.clang }}/lib" >> $GITHUB_ENV
          echo "LLVM_VERSION=${{ steps.clang.outputs.version }}" >> $GITHUB_ENV
          echo "LLVM_CONFIG_PATH=${{ runner.temp }}/llvm-${{ env.clang }}/bin/llvm-config" >> $GITHUB_ENV
      - name: Run rustfmt
        run: cargo fmt --all -- --check
      - name: Run clippy
        run: cargo clippy --all -- -D warnings
      # Docs
      - name: Run rustdoc
        run: cargo rustdoc -- -D warnings
      - name: Build with docs stub
        env:
          DOCS_RS: ""
        run: cargo clean && cargo build
  build:
    name: Build and Test
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        php: ["8.0", "8.1", "8.2", "8.3", "8.4"]
        rust: [stable, nightly]
        clang: ["15", "17"]
        phpts: [ts, nts]
        exclude:
          # ext-php-rs requires nightly Rust when on Windows.
          - os: windows-latest
            rust: stable
          # setup-php doesn't support thread safe PHP on Linux and macOS.
          - os: macos-latest
            phpts: ts
          - os: ubuntu-latest
            phpts: ts
          - os: macos-latest
            clang: "17"
          - os: ubuntu-latest
            clang: "15"
          - os: windows-latest
            clang: "15"
    env:
      CARGO_TERM_COLOR: always
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
        env:
          phpts: ${{ matrix.phpts }}
          debug: true
      - name: Setup Rust
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust }}
          components: rustfmt, clippy
      - run: rustup show
      - name: Cache cargo dependencies
        uses: Swatinem/rust-cache@v2
        # Uncomment the following if statement if caching nightly deps
        # ends up causing too much cache invalidation.
        # if: matrix.rust == 'stable'
        with:
          # increment this manually to force cache eviction
          prefix-key: ${{ env.RUST_CACHE_PREFIX }}
      # LLVM & Clang
      - name: Cache LLVM and Clang
        id: cache-llvm
        uses: actions/cache@v3
        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
        with:
          path: ${{ runner.temp }}/llvm-${{ matrix.clang }}
          key: ${{ matrix.os }}-llvm-${{ matrix.clang }}
      - name: Setup LLVM & Clang
        id: clang
        uses: KyleMayes/install-llvm-action@v2
        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
        with:
          version: ${{ matrix.clang }}
          directory: ${{ runner.temp }}/llvm-${{ matrix.clang }}
      - name: Configure Clang
        # Macos build doesn't work with clang < 18. As a build for version 18 is not available, we skip the setup
        if: "!contains(matrix.os, 'windows') && !contains(matrix.os, 'macos')"
        run: |
          echo "LIBCLANG_PATH=${{ runner.temp }}/llvm-${{ matrix.clang }}/lib" >> $GITHUB_ENV
          echo "LLVM_VERSION=${{ steps.clang.outputs.version }}" >> $GITHUB_ENV
          echo "LLVM_CONFIG_PATH=${{ runner.temp }}/llvm-${{ matrix.clang }}/bin/llvm-config" >> $GITHUB_ENV
      # Build
      - name: Build
        env:
          EXT_PHP_RS_TEST: ""
        run: cargo build --release --features closure,anyhow --all
      # Test
      - name: Test inline examples
        run: cargo test --release --all --features closure,anyhow --no-fail-fast
  build-zts:
    name: Build with ZTS
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Build
        uses: ./.github/actions/zts
  test-embed:
    name: Test with embed
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Test
        uses: ./.github/actions/embed