ci.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: CI

on:
  push:
    branches: ["**"]
  pull_request:
    branches: ["**"]
  schedule:
    - cron: "0 6 * * 1-5"

env:
  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
  CARGO_PROFILE_DEV_DEBUG: false
  RUSTUP_WINDOWS_PATH_ADD_BIN: 1
  # NOTE(fuzzypixelz): This should be changed to "minor" during a release cycle
  # with plans for changes that REQUIRE a minor version bump as defined by the Cargo reference
  # (https://doc.rust-lang.org/cargo/reference/semver.html).
  # However, a minor release could be published without such changes, in which case this variable need not be changed.
  CARGO_SEMVER_CHECKS_RELEASE_TYPE: patch
  # NOTE(fuzzypixelz): cargo-semver-checks uses the previous released version as a baseline, not the latest released
  # version on crates.io. Thus this needs to be updated after every release.
  CARGO_SEMVER_CHECKS_BASELINE_VERSION: 1.0.0

jobs:
  # determine-runner:
  #   runs-on: ubuntu-latest
  #   outputs:
  #     runner: ${{ steps.set-runner.outputs.runner }}
  #   steps:
  #     - name: Clone this repository
  #       uses: actions/checkout@v4

  #     - name: Determine which runner to use
  #       id: set-runner
  #       run: |
  #         if [[ -f ci/runners.json ]]; then
  #           echo "runner=$(cat ci/runners.json)" >> $GITHUB_OUTPUT
  #         else
  #           echo "runner=['ubuntu-latest', 'windows-latest', 'macos-latest']" >> $GITHUB_OUTPUT
  #         fi

  # check:
  #   needs: determine-runner
  #   name: Lints and doc tests on ${{ matrix.os }}
  #   runs-on: ${{ matrix.os }}
  #   strategy:
  #     fail-fast: false
  #     matrix:
  #       os: ${{ fromJSON(needs.determine-runner.outputs.runner) }}

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

  #     - name: Update Stable Rust toolchain
  #       run: rustup update stable

  #     - name: Setup rust-cache
  #       uses: Swatinem/rust-cache@v2
  #       with:
  #         cache-bin: false

  #     - name: Install latest cargo-deny
  #       uses: taiki-e/install-action@cargo-deny

  #     - name: Install latest cargo-machete
  #       uses: taiki-e/install-action@cargo-machete

  #     - name: Install latest cargo-semver-checks
  #       uses: taiki-e/install-action@cargo-semver-checks

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

  #     - name: Clippy zenoh no-default-features
  #       run: cargo +stable clippy -p zenoh --all-targets --no-default-features -- --deny warnings

  #     - name: Clippy zenoh
  #       run: cargo +stable clippy -p zenoh --all-targets -- --deny warnings

  #     - name: Clippy zenoh unstable
  #       run: cargo +stable clippy -p zenoh --all-targets --features unstable -- --deny warnings

  #     - name: Clippy zenoh internal
  #       run: cargo +stable clippy -p zenoh --all-targets --features unstable,internal -- --deny warnings

  #     - name: Clippy zenoh shared-memory
  #       run: cargo +stable clippy -p zenoh --all-targets --features unstable,shared-memory -- --deny warnings

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

  #     - name: Clippy workspace unstable
  #       run: cargo +stable clippy --all-targets --features unstable,test -- --deny warnings

  #     - name: Clippy all features
  #       if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' }}
  #       run: cargo +stable clippy --all-targets --all-features -- --deny warnings

  #     - name: Install generic no_std target
  #       # Generic no_std target architecture is x86_64-unknown-none
  #       run: rustup target add x86_64-unknown-none

  #     - name: Perform no_std checks
  #       run: cargo check --bin nostd_check --target x86_64-unknown-none --manifest-path ci/nostd-check/Cargo.toml

  #     - name: Run doctests
  #       run: cargo test --doc

  #     - name: Build doc
  #       run: cargo doc --no-deps --features unstable
  #       env:
  #         RUSTDOCFLAGS: -Dwarnings

  #     - name: Check licenses
  #       run: cargo deny check licenses

  #     - name: Check unused dependencies
  #       run: cargo machete

  #     - name: Check SemVer Compatibility
  #       run: cargo +stable semver-checks --verbose --default-features --package zenoh --release-type ${{ env.CARGO_SEMVER_CHECKS_RELEASE_TYPE }} --baseline-version ${{ env.CARGO_SEMVER_CHECKS_BASELINE_VERSION }}

  # test:
  #   needs: determine-runner
  #   name: Unit tests on ${{ matrix.os }}
  #   runs-on: ${{ matrix.os }}
  #   strategy:
  #     fail-fast: false
  #     matrix:
  #       os: ${{ fromJSON(needs.determine-runner.outputs.runner) }}

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

  #     - name: Install latest Rust toolchain
  #       run: rustup show

  #     - name: Setup rust-cache
  #       uses: Swatinem/rust-cache@v2
  #       with:
  #         cache-bin: false

  #     - name: Set rustflags
  #       if: ${{ matrix.os == 'windows-latest' }}
  #       shell: bash
  #       run: |
  #         echo "RUSTFLAGS=-Clink-arg=/DEBUG:NONE" >> $GITHUB_ENV

  #     - name: Install latest nextest
  #       uses: taiki-e/install-action@nextest

  #     - name: Run tests
  #       run: cargo nextest run -F test -F internal_config --exclude zenoh-examples --exclude zenoh-plugin-example --workspace

  #     - name: Run tests with SHM
  #       if: ${{ matrix.os == 'macos-latest' || matrix.os == 'windows-latest' }}
  #       run: cargo nextest run -F test -F shared-memory -F unstable -F internal_config -E 'not (test(test_default_features))' --exclude zenoh-examples --exclude zenoh-plugin-example --workspace

  #     - name: Run tests with SHM + unixpipe
  #       if: ${{ matrix.os == 'ubuntu-latest' }}
  #       run: cargo nextest run -F test -F shared-memory -F unstable -F internal_config -F transport_unixpipe -E 'not (test(test_default_features))' --exclude zenoh-examples --exclude zenoh-plugin-example --workspace

  #     - name: Check for feature leaks
  #       if: ${{ matrix.os == 'ubuntu-latest' }}
  #       run: cargo nextest run -p zenohd --no-default-features

  # valgrind:
  #   name: Memory leak checks
  #   runs-on: ubuntu-latest
  #   needs: check
  #   steps:
  #     - name: Clone this repository
  #       uses: actions/checkout@v4

  #     - name: Install latest Rust toolchain
  #       run: rustup show

  #     - name: Install valgrind
  #       uses: taiki-e/install-action@valgrind

  #     - uses: Swatinem/rust-cache@v2
  #       with:
  #         cache-bin: false

  #     - name: Run memory leaks check
  #       run: ci/valgrind-check/run.sh
  #       shell: bash

  # typos:
  #   name: Typos Check
  #   runs-on: ubuntu-latest
  #   steps:
  #     - name: Clone this repository
  #       uses: actions/checkout@v4

  #     - name: Check spelling
  #       uses: crate-ci/typos@master

  # markdown_lint:
  #   runs-on: ubuntu-latest
  #   steps:
  #     - uses: actions/checkout@v4
  #     - uses: DavidAnson/markdownlint-cli2-action@v18
  #       with:
  #         config: ".markdownlint.yaml"
  #         globs: "**/README.md"

  # coverage:
  #   name: Coverage
  #   strategy:
  #     fail-fast: false
  #     matrix:
  #       os: [ubuntu-latest]
  #       rust: [nightly, stable]
  #   runs-on: ${{ matrix.os }}
  #   steps:
  #     - name: Checkout sources
  #       uses: actions/checkout@v4

  #     - name: Install ${{ matrix.rust }} Rust toolchain
  #       run: |
  #         rustup override set ${{ matrix.rust }}
  #         rustup update ${{ matrix.rust }}
  #         rustup component add llvm-tools-preview

  #     - uses: Swatinem/rust-cache@v2
  #       with:
  #         cache-bin: false

  #     - name: Install cargo-llvm-cov
  #       uses: taiki-e/install-action@cargo-llvm-cov

  #     - name: Generate code coverage
  #       run: cargo +${{ matrix.rust }} llvm-cov test --features unstable --features test --features shared-memory ${{ matrix.rust == 'nightly' && '--doctests' || '' }} --lcov --output-path lcov.info --no-cfg-coverage --no-cfg-coverage-nightly --ignore-run-fail -- --skip test_default_features --skip router_linkstate --skip three_node_combination  --skip three_node_combination_multicast

  #     - name: Upload coverage to Codecov
  #       uses: codecov/codecov-action@v4
  #       with:
  #         #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
  #         files: lcov.info
  #         fail_ci_if_error: true

  msrvs:
    name: MSRV checks on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    # NOTE: It is necessary to run the check-msrv action on platforms since a crate's MSRV
    # depends on the target it's compiled for.
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - macos-13
          - macos-14
          - windows-latest
    steps:
      - name: Clone this repository
        uses: actions/checkout@v4

      - uses: ZettaScaleLabs/ci/check-msrv@develop
        with:
          repo: ${{ github.repository }}
          # NOTE: As of commit 25f06bd, the minimum MSRV found in the workspace is 1.68.
          # This value should be as high as possible to avoid needlessly checking older versions.
          min: 1.68.2

  # NOTE: In GitHub repository settings, the "Require status checks to pass
  # before merging" branch protection rule ensures that commits are only merged
  # from branches where specific status checks have passed. These checks are
  # specified manually as a list of workflow job names. Thus we use this extra
  # job to signal whether all CI checks have passed.
  ci:
    name: CI status checks
    runs-on: ubuntu-latest
    # needs: [check, test, valgrind, typos, markdown_lint, coverage]
    if: always()
    steps:
      - name: Check whether all jobs pass
        run: echo '${{ toJson(needs) }}' | jq -e 'all(.result == "success")'