pre-release.yml

#
# Copyright (c) 2023 ZettaScale Technology
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
# which is available at https://www.apache.org/licenses/LICENSE-2.0.
#
# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
#
# Contributors:
#   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
#
name: Pre-Release

on:
  workflow_dispatch:
    inputs:
      features:
        description: Build with specified features (comma separated, no space)
        type: string
  workflow_call:
    inputs:
      features:
        description: Build with specified features (comma separated, no space)
        type: string

jobs:
  checks:
    name: Code checks
    runs-on: ubuntu-latest
    strategy:
      matrix:
        image: [ "ubuntu:20.04", "ubuntu:22.04", "ubuntu:24.04" ]
    container:
      image: ${{ matrix.image }}
      options: --sysctl net.ipv6.conf.all.disable_ipv6=0 -e DEBIAN_FRONTEND=noninteractive
    steps:
      - name: Update and install packages
        run: apt-get update && apt-get install -y curl git build-essential pkg-config libssl-dev

      - name: Install Rust toolchain
        run: |
          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
          echo "$HOME/.cargo/bin" >> $GITHUB_PATH

      - name: Clone this repository
        uses: actions/checkout@v4

      - name: Install rustup components
        run: rustup component add rustfmt clippy

      - name: Code format check
        run: rustfmt --check --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate,skip_children=true" $(git ls-files '*.rs')
        env:
          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse

      - name: Clippy check
        run: cargo +stable clippy --all-targets --features=${{ inputs.features }} -- --deny warnings

      - name: Clippy unstable check
        run: cargo +stable clippy --all-targets  -- --deny warnings

      - name: Clippy all features
        run: cargo +stable clippy --all-targets --all-features -- --deny warnings

  tests:
    name: Tests
    needs: checks
    runs-on: ubuntu-latest
    strategy:
      matrix:
        image: [ "ubuntu:20.04", "ubuntu:22.04", "ubuntu:24.04" ]
    container:
      image: ${{ matrix.image }}
      options: --sysctl net.ipv6.conf.all.disable_ipv6=0 -e DEBIAN_FRONTEND=noninteractive
    steps:
      - name: Update and install packages
        run: apt-get update && apt-get install -y curl git build-essential pkg-config libssl-dev

      - name: Install Rust toolchain
        run: |
          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
          echo "$HOME/.cargo/bin" >> $GITHUB_PATH

      - name: Clone this repository
        uses: actions/checkout@v4

      - name: Install nextest
        run: cargo +stable install --locked cargo-nextest
        env:
          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse

      - name: Run tests
        run: cargo nextest run --release --features=${{ inputs.features }} --verbose
        env:
          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
          ASYNC_STD_THREAD_COUNT: 4

      - name: Run doctests
        run: cargo test --release --features=${{ inputs.features }} --doc
        env:
          CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
          ASYNC_STD_THREAD_COUNT: 4

  doc:
    name: Generate documentation
    needs: checks
    runs-on: ubuntu-latest
    steps:
      - name: Clone this repository
        uses: actions/checkout@v4

      #
      # Temporary workaround to remmove transitive dependency
      # of static-init 1.0.3 which fails with nigtly Rust.
      # This allows Rust to automatically pick a compatible version 1.0.4
      # where the issue is fixed.
      #
      - name: Remove zenoh-pinned-deps-1-75 dependency and Cargo.lock
        run: | 
          sed -i '/zenoh-pinned-deps-1-75/d' Cargo.toml
          rm -f Cargo.lock

      # Use a similar command than docs.rs build: rustdoc with nightly toolchain
      - name: Install Rust toolchain nightly for docs gen
        run: rustup toolchain install nightly

      - name: Run rustdoc using Nightly Rust and Zenoh unstable
        # NOTE: force 'unstable' feature for doc generation, as forced for docs.rs build in zenoh/Cargo.toml
        run: >
          cargo +nightly rustdoc --manifest-path ./zenoh/Cargo.toml --lib --features unstable -j3
          -Z rustdoc-map -Z unstable-options -Z rustdoc-scrape-examples
          --config build.rustdocflags='["-Z", "unstable-options", "--emit=invocation-specific", "--cap-lints", "warn", "--disable-per-crate-search", "--extern-html-root-takes-precedence"]'
        env:
          RUSTDOCFLAGS: -Dwarnings