build.yaml

name: Build

on:
  workflow_call:
    inputs:
      disable_extra_builds:
        type: boolean
      disable_tests:
        type: boolean
      extra_packages:
        type: string
      runs_on:
        default: ubuntu-latest
        type: string
      target:
        required: true
        type: string
      toolchain:
        default: stable
        type: string
      pin-incompatible-msrv-bump-dependencies:
        default: false
        type: boolean
      continue-on-error:
        default: false
        type: boolean

env:
  # While we could define these on a per-job basis, there's no harm in simply
  # defining all environment variables for each job. This has the added benefit
  # of keeping them all together in one place.
  CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
  CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc
  CARGO_TARGET_ARMV5TE_UNKNOWN_LINUX_GNUEABI_LINKER: arm-linux-gnueabi-gcc
  CARGO_TARGET_ARMV5TE_UNKNOWN_LINUX_MUSLEABI_LINKER: arm-linux-gnueabi-gcc
  CARGO_TARGET_ARMV7_UNKNOWN_LINUX_GNUEABIHF_LINKER: arm-linux-gnueabihf-gcc
  CARGO_TARGET_ARMV7_UNKNOWN_LINUX_MUSLEABIHF_LINKER: arm-linux-gnueabihf-gcc
  CARGO_TARGET_ARM_UNKNOWN_LINUX_GNUEABIHF_LINKER: arm-linux-gnueabihf-gcc
  CARGO_TARGET_ARM_UNKNOWN_LINUX_GNUEABI_LINKER: arm-linux-gnueabi-gcc
  CARGO_TARGET_ARM_UNKNOWN_LINUX_MUSLEABI_LINKER: arm-linux-gnueabi-gcc
  CARGO_TARGET_MIPS64EL_UNKNOWN_LINUX_GNUABI64_LINKER: mips64el-linux-gnuabi64-gcc
  CARGO_TARGET_MIPS64_UNKNOWN_LINUX_GNUABI64_LINKER: mips64-linux-gnuabi64-gcc
  CARGO_TARGET_MIPSEL_UNKNOWN_LINUX_GNU_LINKER: mipsel-linux-gnu-gcc
  CARGO_TARGET_MIPSEL_UNKNOWN_LINUX_MUSL_LINKER: mipsel-linux-gnu-gcc
  CARGO_TARGET_MIPS_UNKNOWN_LINUX_GNU_LINKER: mips-linux-gnu-gcc
  CARGO_TARGET_MIPS_UNKNOWN_LINUX_MUSL_LINKER: mips-linux-gnu-gcc
  CARGO_TARGET_POWERPC64LE_UNKNOWN_LINUX_GNU_LINKER: powerpc64le-linux-gnu-gcc
  CARGO_TARGET_POWERPC64_UNKNOWN_LINUX_GNU_LINKER: powerpc64-linux-gnu-gcc
  CARGO_TARGET_POWERPC_UNKNOWN_LINUX_GNU_LINKER: powerpc-linux-gnu-gcc
  CARGO_TARGET_S390X_UNKNOWN_LINUX_GNU_LINKER: s390x-linux-gnu-gcc
  # Pretty cargo output!
  CARGO_TERM_COLOR: always
  # Enable cross compilation for `pkg_config`.
  PKG_CONFIG_ALLOW_CROSS: 1
  # Deny warnings.
  RUSTFLAGS: -D warnings

jobs:
  build:
    runs-on: ${{ inputs.runs_on }}
    continue-on-error: ${{ inputs.continue-on-error }}
    steps:
      - name: Build | install dependencies
        if: inputs.runs_on == 'ubuntu-latest'
        run: |
          sudo sed -i 's/azure.archive.ubuntu.com/archive.ubuntu.com/' /etc/apt/sources.list
          sudo apt-get -qq update
          sudo apt-get -qq -y install build-essential curl git pkg-config ${{ inputs.extra_packages }}

      - name: Build | add mingw32 to path
        if: inputs.runs_on == 'windows-2025'
        shell: bash
        run: |
          echo "C:\msys64\mingw32\bin" >> $GITHUB_PATH

      - name: Build | checkout
        uses: actions/checkout@v2

      - name: Build | install toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          target: ${{ inputs.target }}
          toolchain: ${{ inputs.toolchain }}

      - name: Build | rust-cache
        uses: Swatinem/rust-cache@v2

        # Pin some dependencies (for building with MSRV 1.59.0) just here in CI
        # and not via Cargo.toml. The latter would enforce them to all users
        # and not just the ones who want to build with an old Rust release. See
        # issue https://github.com/serialport/serialport-rs/issues/324.
        #
        # The command line arguments below are for Cargo 1.59.0. The have
        # changed with newer releases and need to be adjusted when bumbing our
        # MSRV.
      - name: Build | pin some dependencies for building with MSRV
        if: ${{ inputs.pin-incompatible-msrv-bump-dependencies == true }}
        run: |
          cargo update --precise 0.10.0 --package core-foundation
          cargo update --precise 0.2.163 --package libc
          cargo update --precise 1.0.101 --package proc-macro2
          cargo update --precise 1.0.40 --package quote
          cargo update --precise 1.0.22 --package unicode-ident

      - name: Build | build library (default features)
        run: cargo build --target=${{ inputs.target }}

      - name: Build | build library (no default features)
        run: cargo build --no-default-features --target=${{ inputs.target }}

      - name: Build | build library (all features)
        run: cargo build --all-features --target=${{ inputs.target }}

      - name: Build | build examples (default features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --examples --target=${{ inputs.target }}

      - name: Build | build examples (no default features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --no-default-features --examples --target=${{ inputs.target }}

      - name: Build | build examples (all features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --examples --all-features --target=${{ inputs.target }}

      - name: Build | build tests (default features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --tests --target=${{ inputs.target }}

      - name: Build | run tests (default features)
        if: ${{ inputs.disable_tests == false }}
        run: cargo test --no-fail-fast --target=${{ inputs.target }}

      - name: Build | build tests (no default features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --tests --no-default-features --target=${{ inputs.target }}

      - name: Build | run tests (no default features)
        if: ${{ inputs.disable_tests == false }}
        run: cargo test --no-default-features --no-fail-fast --target=${{ inputs.target }}

      - name: Build | build tests (selected features)
        if: ${{ inputs.disable_extra_builds == false }}
        run: cargo build --tests --features libudev,usbportinfo-interface --target=${{ inputs.target }}

      - name: Build | run tests (selected features)
        if: ${{ inputs.disable_tests == false }}
        run: cargo test --no-fail-fast --features libudev,usbportinfo-interface --target=${{ inputs.target }}