.github/workflows/ci.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: CI
on:
  pull_request:
    branches: [ main ]
  push:
    branches: [ main ]

env:
  CARGO_INCREMENTAL: "0"
  CARGO_TERM_COLOR: always

# Concurrency strategy:
#   github.workflow: distinguish this workflow from others
#   github.event_name: distinguish `push` event from `pull_request` event
#   github.event.number: set to the number of the pull request if `pull_request` event
#   github.run_id: otherwise, it's a `push` event, only cancel if we rerun the workflow
#
# Reference:
#   https://docs.github.com/en/actions/using-jobs/using-concurrency
#   https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
concurrency:
  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.number || github.run_id }}
  cancel-in-progress: true

jobs:
  check:
    name: Check
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    env:
      RUSTUP_TOOLCHAIN: nightly
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Install nightly toolchain
        run: >-
          rustup toolchain install nightly
          --profile minimal
          --component rustfmt
          --component clippy
          --allow-downgrade
          --no-self-update
      - uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
      - uses: taiki-e/install-action@84f5ac3124727fb3d284d4d22ee9ab3654fd09a6 # v2.87.7
        with:
          tool: typos-cli,taplo-cli,hawkeye
      - run: cargo x lint
      - name: Check feature matrix
        run: cargo x check
      - name: Compile benchmarks
        run: cargo x bench --no-run

  test:
    name: Run tests
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-24.04, macos-14, windows-2022 ]
        rust-version: [ "1.86.0", "stable" ]
    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    env:
      RUSTUP_TOOLCHAIN: ${{ matrix.rust-version }}
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Install Rust ${{ matrix.rust-version }}
        run: >-
          rustup toolchain install ${{ matrix.rust-version }}
          --profile minimal
          --no-self-update
      - uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
      - name: Run unit tests
        run: cargo x test --no-capture
        shell: bash

  miri:
    name: Run Miri tests
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    env:
      RUSTUP_TOOLCHAIN: nightly
      MIRIFLAGS: >-
        -Zmiri-strict-provenance
        -Zmiri-symbolic-alignment-check
        -Zmiri-many-seeds=0..4
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Install nightly toolchain
        run: >-
          rustup toolchain install nightly
          --profile minimal
          --component miri
          --allow-downgrade
          --no-self-update
      - uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
      - name: Set up Miri
        run: cargo +nightly miri setup
      - name: Run Miri tests
        run: cargo x miri

  required:
    name: Required
    runs-on: ubuntu-24.04
    if: ${{ always() }}
    needs:
      - check
      - miri
      - test
    steps:
      - name: Guardian
        run: |
          if [[ ! ( \
                 "${{ needs.check.result }}" == "success" \
              && "${{ needs.miri.result }}" == "success" \
              && "${{ needs.test.result }}" == "success" \
              ) ]]; then
            echo "Required jobs haven't been completed successfully."
            exit -1
          fi