multiboot2/.github/workflows/_build-rust.yml

# Reusable GitHub CI workflow:
# More info: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iduses

# Common Rust CI setup that checkout the repo, installs the common toolchain
# and set's up the cargo cache. It builds, tests, and lints the code.

on:
  workflow_call:
    inputs:
      rust-version:
        type: string
        required: false
        default: stable
        description: Rust version
      rust-target:
        type: string
        required: false
        default: x86_64-unknown-linux-gnu
        description: Rust target for the build step. Clippy and tests are still executed with the default target.
      features:
        type: string
        required: false
        # Make sure we always an empty string to "--features <FEATURES>"
        default: '""'
        description: Comma-separated String with additional Rust features relevant for a certain job.
      do-style-check:
        type: boolean
        required: false
        default: true
        description: Perform code and doc style checks.
      do-test:
        type: boolean
        required: false
        default: true
        description: Execute tests.

jobs:
  check_rust:
    runs-on: ubuntu-latest
    steps:
      - name: Check out
        uses: actions/checkout@v3
      - name: Set up rustup cache
        uses: actions/cache@v3
        continue-on-error: false
        with:
          path: |
            ~/.rustup/downloads
            ~/.rustup/toolchains
          # key: ${{ runner.os }}-rustup-${{ inputs.rust-version }}-${{ inputs.rust-target }}-${{ hashFiles('**/rustup-toolchain.toml') }}
          key: ${{ runner.os }}-rustup-${{ inputs.rust-version }}-${{ inputs.rust-target }}
      # The effect of this is must smaller than the cache for Cargo. However, it
      # still saves a few seconds. Note that many CI runs within a week may
      # quickly bring you close to the 10GB limit:
      # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#managing-caches
      - name: Install Rust Toolchain via Rustup
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: ${{ inputs.rust-version }}
          override: true
          components: clippy, rustfmt
          target: ${{ inputs.rust-target }}
      - name: Set up Cargo cache
        uses: actions/cache@v3
        continue-on-error: false
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          # We do not have a Cargo.lock here, so I hash Cargo.toml
          key: ${{ runner.os }}-rust-${{ inputs.rust-version }}-cargo-${{ hashFiles('**/Cargo.toml') }}
      - run: cargo version
      - name: Build (library)
        run: cargo build --target ${{ inputs.rust-target }} --features ${{ inputs.features }}
      - name: Build (all targets)
        run: cargo build --all-targets --features ${{ inputs.features }}
      - name: Code Formatting
        if: ${{ inputs.do-style-check }}
        run: cargo fmt --all -- --check
      - name: Code Style and Doc Style
        if: ${{ inputs.do-style-check }}
        run: |
          cargo doc --document-private-items --features ${{ inputs.features }}
          cargo clippy --all-targets --features ${{ inputs.features }}
      - name: Unit Test
        if: ${{ inputs.do-test }}
        run: |
          curl -LsSf https://get.nexte.st/latest/linux | tar zxf -
          chmod u+x cargo-nextest
          ./cargo-nextest nextest run --features ${{ inputs.features }}