rust.yml

name: Rust

on:
  push:
    branches: [main, release/**]
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_protected == 'true' && github.sha || github.ref }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash

jobs:

  complete:
    if: always()
    needs: [fmt, cargo-deny, check-generated-full-help-docs, build-and-test, publish-dry-run]
    runs-on: ubuntu-latest
    steps:
    - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
      run: exit 1

  fmt:
    runs-on: ubuntu-latest-16-cores
    steps:
    - uses: actions/checkout@v4
    - run: rustup update
    - run: cargo fmt --all --check

  cargo-deny:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        check: [advisories, bans, licenses, sources]
    continue-on-error: ${{ matrix.check == 'advisories' }}
    steps:
    - uses: actions/checkout@v3
    - uses: EmbarkStudios/cargo-deny-action@b01e7a8cfb1f496c52d77361e84c1840d8246393
      with:
        command: check ${{ matrix.check }}

  check-generated-full-help-docs:
    runs-on: ubuntu-latest-16-cores
    steps:
    - uses: actions/checkout@v4
    - uses: stellar/actions/rust-cache@main
    - run: rustup update
    - run: make generate-full-help-doc
    - run: git add -N . && git diff HEAD --exit-code

  build-and-test:
    strategy:
      fail-fast: false
      matrix:
        rust: [msrv, latest]
        sys:
        - os: ubuntu-latest-16-cores
          target: x86_64-unknown-linux-gnu
        - os: ubuntu-jammy-16-cores-arm64
          target: aarch64-unknown-linux-gnu
        - os: macos-latest
          target: x86_64-apple-darwin
        - os: macos-latest
          target: aarch64-apple-darwin
        - os: windows-latest-8-cores
          target: x86_64-pc-windows-msvc
    runs-on: ${{ matrix.sys.os }}
    env:
      CI_TESTS: true
    steps:
    - uses: actions/checkout@v4
    - uses: stellar/actions/rust-cache@main
    - name: Use the minimum supported Rust version
      if: matrix.rust == 'msrv'
      run: |
        msrv="$(cargo metadata --format-version 1 --no-deps | jq -r '.packages | map(.rust_version) | map(values) | min')"
        rustup override set $msrv
        rustup component add clippy --toolchain $msrv
    - name: Error on warnings and clippy checks
      # Only error on warnings and checks for the msrv, because new versions of
      # Rust will frequently add new warnings and checks.
      if: matrix.rust == 'msrv'
      run: echo RUSTFLAGS='-Dwarnings -Dclippy::all -Dclippy::pedantic' >> $GITHUB_ENV
    - run: rustup update
    - run: cargo version
    - run: rustup target add ${{ matrix.sys.target }}
    - run: rustup target add wasm32-unknown-unknown
    - if: runner.os == 'Linux'
      run: sudo apt-get update && sudo apt-get -y install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu libudev-dev
    - run: cargo clippy --all-targets --target ${{ matrix.sys.target }}
    - run: make test
      env:
        CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
        CARGO_BUILD_TARGET: ${{ matrix.sys.target }}

  publish-dry-run:
    if: github.event_name == 'push' || startsWith(github.head_ref, 'release/')
    strategy:
      fail-fast: false
      matrix:
        include:
        - os: ubuntu-latest-16-cores
          target: x86_64-unknown-linux-gnu
          cargo-hack-feature-options: --feature-powerset
          additional-deb-packages: libudev-dev
        # TODO: add back ARM support
        #- os: ubuntu-latest-16-cores
        #  target: aarch64-unknown-linux-gnu
        #  cargo-hack-feature-options: --feature-powerset
        #  additional-deb-packages: libudev-dev libssl-dev
        - os: macos-latest
          target: x86_64-apple-darwin
          cargo-hack-feature-options: --feature-powerset
        - os: macos-latest
          target: aarch64-apple-darwin
          cargo-hack-feature-options: --feature-powerset
        # Windows builds notes:
        #
        # The different features that need testing are split over unique
        # isolated builds for Windows, because there's a bug in Cargo [1] that
        # causes builds of wasm-opt [2] to fail when run one after the other and
        # attempting to clean up artifacts in between. The bug has been fixed,
        # but will not make it into a stable release of Cargo until ~August
        # 2023.
        #
        # [1]: https://github.com/rust-lang/cargo/pull/11442
        # [2]: https://github.com/brson/wasm-opt-rs/issues/116
        - os: windows-latest-8-cores
          target: x86_64-pc-windows-msvc
          cargo-hack-feature-options: ''
        - os: windows-latest-8-cores
          target: x86_64-pc-windows-msvc
          cargo-hack-feature-options: --features opt --ignore-unknown-features

    uses: stellar/actions/.github/workflows/rust-publish-dry-run-v2.yml@main
    with:
      runs-on: ${{ matrix.os }}
      target: ${{ matrix.target }}
      cargo-hack-feature-options: ${{ matrix.cargo-hack-feature-options }}
      additional-deb-packages: ${{ matrix.additional-deb-packages }}