build.yml

---
name: Stackable Build Pipeline

on:
  push:
    branches:
      - main
      - staging
      - trying
      - "renovate/**"
    tags:
      - "*"
  pull_request:
  merge_group:

permissions: {}

env:
  CARGO_TERM_COLOR: always
  CARGO_INCREMENTAL: "0"
  CARGO_PROFILE_DEV_DEBUG: "0"
  RUST_TOOLCHAIN_VERSION: "1.95.0"
  RUSTFLAGS: "-D warnings"
  RUSTDOCFLAGS: "-D warnings"
  RUST_LOG: "info"

jobs:
  # Identify unused dependencies
  run_udeps:
    name: Run Cargo Udeps
    runs-on: ubuntu-latest
    permissions:
      contents: read
    env:
      RUSTC_BOOTSTRAP: "1"

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false

      - name: Install rust toolchain
        run: |
          rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" --profile minimal
          rustup default "${RUST_TOOLCHAIN_VERSION}"

      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
        with:
          key: udeps

      - name: Install cargo-udeps
        run: cargo install cargo-udeps --locked

      - name: Check for unused dependencies
        run: cargo udeps --all-targets --all-features

  run_cargodeny:
    name: Run Cargo Deny
    runs-on: ubuntu-latest
    permissions:
      contents: read

    strategy:
      matrix:
        checks:
          - advisories
          - bans licenses sources

    # Prevent sudden announcement of a new advisory from failing ci:
    continue-on-error: ${{ matrix.checks == 'advisories' }}

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false

      - uses: EmbarkStudios/cargo-deny-action@3fd3802e88374d3fe9159b834c7714ec57d6c979 # v2.0.15
        with:
          command: check ${{ matrix.checks }}

  run_rustfmt:
    name: Run Rustfmt
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false

      - name: Install Rust toolchain with rustfmt
        run: |
          rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" \
            --profile minimal \
            --component rustfmt
          rustup default "${RUST_TOOLCHAIN_VERSION}"

      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
        with:
          key: fmt

      - name: Run Rustfmt
        run: cargo fmt --all -- --check

  run_clippy:
    name: Run Clippy
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      - name: Install host dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --yes \
            protobuf-compiler \
            krb5-user \
            libkrb5-dev \
            libclang-dev \
            liblzma-dev \
            libssl-dev \
            pkg-config

      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          submodules: recursive
          persist-credentials: false

      - name: Install Rust toolchain with Clippy
        run: |
          rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" \
            --profile minimal \
            --component clippy
          rustup default "${RUST_TOOLCHAIN_VERSION}"

      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
        with:
          key: clippy

      - name: Run Clippy
        run: cargo clippy --color never -q --all-targets -- -D warnings
  run_rustdoc:
    name: Run RustDoc
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        run: |
          rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" --profile minimal
          rustup default "${RUST_TOOLCHAIN_VERSION}"

      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
        with:
          key: doc

      - name: Build documentation
        run: cargo doc --document-private-items

  run_tests:
    name: Run Cargo Tests
    needs:
      - run_clippy
      - run_rustfmt
      - run_rustdoc
    runs-on: ubuntu-latest
    permissions:
      contents: read  # Required by actions/checkout.

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false

      - name: Install Rust toolchain with rust-src
        run: |
          rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" \
            --profile minimal \
            --component rust-src
          rustup default "${RUST_TOOLCHAIN_VERSION}"

          # rust-src is required for trybuild stderr output comparison to work
          # for our cases.
          # See: https://github.com/dtolnay/trybuild/issues/236#issuecomment-1620950759
      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
        with:
          key: test

      - name: Run tests
        run: cargo test --all-features

  tests_passed:
    name: All tests passed
    needs:
      - run_udeps
      - run_cargodeny
      - run_tests
    runs-on: ubuntu-latest
    permissions: {}

    steps:
      - name: log
        run: echo All tests have passed!