Skip to content

anng: adapt to NNG v2.0.0-alpha.7 API #211

anng: adapt to NNG v2.0.0-alpha.7 API

anng: adapt to NNG v2.0.0-alpha.7 API #211

Workflow file for this run

# This workflow runs whenever a PR is opened or updated, or a commit is pushed to main. It runs
# several checks:
# - fmt: checks that the code is formatted according to rustfmt
# - clippy: checks that the code does not contain any clippy warnings
# - doc: checks that the code can be documented without errors
# - hack: check combinations of feature flags
# - msrv: check that the msrv specified in the crate is correct
permissions:
contents: read
# This configuration allows maintainers of this repo to create a branch and pull request based on
# the new branch. Restricting the push trigger to the main branch ensures that the PR only gets
# built once.
on:
push:
branches: [main]
pull_request:
# If new code is pushed to a PR branch, then cancel in progress workflows for that PR. Ensures that
# we don't waste CI time, and returns results quicker https://github.com/jonhoo/rust-ci-conf/pull/5
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
name: check
jobs:
fmt:
runs-on: ubuntu-latest
name: stable / fmt
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: stable
components: rustfmt
- name: cargo fmt --check
run: cargo fmt --check
clippy:
runs-on: ubuntu-latest
name: ${{ matrix.toolchain }} / clippy
permissions:
contents: read
checks: write
strategy:
fail-fast: false
matrix:
# Get early warning of new lints which are regularly introduced in beta channels.
toolchain: [stable, beta]
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Make nng buildable from source
run: sudo apt-get install -y clang cmake
- name: Install ${{ matrix.toolchain }}
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: ${{ matrix.toolchain }}
components: clippy
- name: cargo clippy
uses: giraffate/clippy-action@13b9d32482f25d29ead141b79e7e04e7900281e0 # tag=v1.0.1
with:
reporter: 'github-pr-check'
github_token: ${{ secrets.GITHUB_TOKEN }}
semver:
runs-on: ubuntu-latest
name: semver
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Make nng buildable from source with all features
run: sudo apt-get install -y clang cmake libclang-dev libmbedtls-dev
- name: Install stable
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: stable
components: rustfmt
- name: cargo-semver-checks
uses: obi1kenobi/cargo-semver-checks-action@5b298c9520f7096a4683c0bd981a7ac5a7e249ae # tag=v2.8
doc:
# run docs generation on nightly rather than stable. This enables features like
# https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an
# API be documented as only available in some specific platforms.
runs-on: ubuntu-latest
name: nightly / doc
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Make nng buildable from source
run: sudo apt-get install -y clang cmake
- name: Install nightly
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: nightly
- name: Install cargo-docs-rs
uses: dtolnay/install@982daea0f5d846abc3c83e01a6a1d73c040047c1 # branch=cargo-docs-rs
- name: cargo docs-rs -p nng-sys
run: cargo docs-rs -p nng-sys
- name: cargo docs-rs -p nng
run: cargo docs-rs -p nng
hack:
# cargo-hack checks combinations of feature flags to ensure that features are all additive
# which is required for feature unification
runs-on: ubuntu-latest
name: ubuntu / stable / features
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Install stable
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: stable
- name: cargo install cargo-hack
uses: taiki-e/install-action@a983ca795126a4be4e8a44879ac5c4c3ef66cae1 # tag=v2.65.11
with:
tool: cargo-hack
# since we're trying every combination here, we need to ensure we have
# all the various tools installed already.
- name: install tools
run: sudo apt-get install -y libclang-dev clang cmake ninja-build libmbedtls-dev libnng1 libnng-dev
# Run cargo hack per-package because nng-sys v0.4 targets NNG v2, while
# nng and anng still depend on nng-sys v0.3 (NNG v1). Running feature-powerset
# on the entire workspace fails since these require incompatible NNG versions.
# The effect of the failure (when running `hack` on the workspace) is here:
# https://github.com/nanomsg/nng-rs/actions/runs/20988550343/job/60328143824
#
# TODO: Remove this workaround once nng is migrated to nng-sys v0.4/NNG v2
# and revert to:
# - name: cargo hack
# run: cargo hack --feature-powerset check --skip source-update-bindings
#
# intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4
# --feature-powerset runs for every combination of features
- name: cargo hack nng
run: cargo hack -p nng --feature-powerset check
- name: remove NNG v1
run: sudo apt-get remove -y libnng1 libnng-dev
- name: build and install NNG v2 for nng-sys
run: .github/scripts/install-nng.sh
- name: cargo hack anng
run: cargo hack -p anng --feature-powerset check
env:
# add /usr/local/include to the C compiler search path for NNG headers
CFLAGS: -I/usr/local/include
# add /usr/local/lib to the linker search path for NNG libraries
RUSTFLAGS: -L native=/usr/local/lib
- name: cargo hack nng-sys
run: cargo hack -p nng-sys --feature-powerset check --skip source-update-bindings
env:
# add /usr/local/include to the C compiler search path for NNG headers
CFLAGS: -I/usr/local/include
# add /usr/local/lib to the linker search path for NNG libraries
RUSTFLAGS: -L native=/usr/local/lib
msrv:
# check that we can build using the minimal rust version that is specified by this crate
runs-on: ubuntu-latest
# we use a matrix here just because env can't be used in job names
# https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability
strategy:
matrix:
msrv: ["1.85.0"] # Waker::noop
name: ubuntu / ${{ matrix.msrv }}
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # tag=v6.0.1
with:
submodules: true
- name: Make nng buildable from source
run: sudo apt-get install -y clang cmake
- name: Install ${{ matrix.msrv }}
uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # branch=master
with:
toolchain: ${{ matrix.msrv }}
- name: cargo +${{ matrix.msrv }} check
run: cargo check