irtt-rs/.github/workflows/ci.yml

name: Rust CI

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

permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always

jobs:
  fmt:
    name: cargo fmt
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        uses: actions-rust-lang/setup-rust-toolchain@166cdcfd11aee3cb47222f9ddb555ce30ddb9659 # v1
        with:
          components: rustfmt
          cache-key: fmt

      - name: Check formatting
        uses: actions-rust-lang/rustfmt@4066006ec54a31931b9b1fddfd38f2fdf2d27143 # v1

  clippy:
    name: cargo clippy
    runs-on: ubuntu-latest
    timeout-minutes: 20

    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        uses: actions-rust-lang/setup-rust-toolchain@166cdcfd11aee3cb47222f9ddb555ce30ddb9659 # v1
        with:
          components: clippy
          cache-key: clippy

      - name: Run clippy
        run: |
          cargo clippy \
            --workspace \
            --all-targets \
            --all-features \
            --locked \
            -- -D warnings

      - name: Run clippy without default features
        run: |
          cargo clippy \
            --workspace \
            --all-targets \
            --no-default-features \
            --locked \
            -- -D warnings

  verify:
    name: cargo ${{ matrix.task }} (${{ matrix.target }})
    strategy:
      fail-fast: false
      matrix:
        include:
          - task: check
            runner: ubuntu-24.04
            target: x86_64-unknown-linux-gnu
            musl: false

          - task: test
            runner: ubuntu-24.04
            target: x86_64-unknown-linux-gnu
            musl: false

          - task: check
            runner: ubuntu-24.04
            target: x86_64-unknown-linux-musl
            musl: true

          - task: test
            runner: ubuntu-24.04
            target: x86_64-unknown-linux-musl
            musl: true

          - task: check
            runner: ubuntu-24.04-arm
            target: aarch64-unknown-linux-gnu
            musl: false

          - task: test
            runner: ubuntu-24.04-arm
            target: aarch64-unknown-linux-gnu
            musl: false

          - task: check
            runner: ubuntu-24.04-arm
            target: aarch64-unknown-linux-musl
            musl: true

          - task: test
            runner: ubuntu-24.04-arm
            target: aarch64-unknown-linux-musl
            musl: true

    runs-on: ${{ matrix.runner }}
    timeout-minutes: 25

    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          persist-credentials: false

      - name: Install musl toolchain
        if: matrix.musl
        run: |
          sudo apt-get update
          sudo apt-get install --no-install-recommends musl-tools

      - name: Install Rust toolchain
        uses: actions-rust-lang/setup-rust-toolchain@166cdcfd11aee3cb47222f9ddb555ce30ddb9659 # v1
        with:
          target: ${{ matrix.target }}
          cache-key: ${{ matrix.task }}-${{ matrix.target }}

      - name: Run ${{ matrix.task }} with all features
        run: |
          cargo ${{ matrix.task }} \
            --workspace \
            --all-targets \
            --all-features \
            --target ${{ matrix.target }} \
            --locked

      - name: Run ${{ matrix.task }} without default features
        run: |
          cargo ${{ matrix.task }} \
            --workspace \
            --all-targets \
            --no-default-features \
            --target ${{ matrix.target }} \
            --locked

  docs:
    name: cargo doc
    runs-on: ubuntu-latest
    timeout-minutes: 20

    env:
      RUSTDOCFLAGS: "-D warnings"

    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        uses: actions-rust-lang/setup-rust-toolchain@166cdcfd11aee3cb47222f9ddb555ce30ddb9659 # v1
        with:
          cache-key: docs

      - name: Check docs
        run: |
          cargo doc \
            --workspace \
            --all-features \
            --no-deps \
            --locked