Skip to content
CI

CI #2384

Sign in to view logs

CI

CI #2384

Workflow file for this run

.github/workflows/ci.yml at 9439b55
env:
# We aim to always test with the latest stable Rust toolchain, however we pin to a specific
# version like 1.70. Note that we only specify MAJOR.MINOR and not PATCH so that bugfixes still
# come automatically. If the version specified here is no longer the latest stable version,
# then please feel free to submit a PR that adjusts it along with the potential clippy fixes.
RUST_STABLE_VER: "1.82" # In quotes because otherwise (e.g.) 1.70 would be interpreted as 1.7
# The purpose of checking with the minimum supported Rust toolchain is to detect its staleness.
# If the compilation fails, then the version specified here needs to be bumped up to reality.
# Be sure to also update the rust-version property in the workspace Cargo.toml file,
# plus all the README.md files of the affected packages.
RUST_MIN_VER: "1.81"
# List of packages that will be checked with the minimum supported Rust version.
# This should be limited to packages that are intended for publishing.
RUST_MIN_VER_PKGS: "-p xilem -p xilem_core -p masonry"
# List of packages that can not target Wasm.
NO_WASM_PKGS: "--exclude masonry --exclude xilem"
# Only some of our examples support Android (primarily due to extra required boilerplate).
ANDROID_TARGETS: "-p xilem --example mason_android --example calc_android --example stopwatch_android --example variable_clock_android --example http_cats_android --example to_do_mvc_android"
# Whether the workspace contains Rust code using the debug_assertions configuration option.
USING_DEBUG_ASSERTIONS: "true"
# Rationale
#
# We don't run clippy with --all-targets because then even --lib and --bins are compiled with
# dev dependencies enabled, which does not match how they would be compiled by users.
# A dev dependency might enable a feature that we need for a regular dependency,
# and checking with --all-targets would not find our feature requirements lacking.
# This problem still applies to cargo resolver version 2.
# Thus we split all the targets into two steps, one with --lib --bins
# and another with --tests --benches --examples.
# Also, we can't give --lib --bins explicitly because then cargo will error on binary-only packages.
# Luckily the default behavior of cargo with no explicit targets is the same but without the error.
#
# We use cargo-hack for a similar reason. Cargo's --workspace will do feature unification across
# the whole workspace. While cargo-hack will instead check each workspace package separately.
#
# Using cargo-hack also allows us to more easily test the feature matrix of our packages.
# We use --each-feature & --optional-deps which will run a separate check for every feature.
#
# We use cargo-nextest, which has a faster concurrency model for running tests.
# However cargo-nextest does not support running doc tests, so we also have a cargo test --doc step.
# For more information see https://github.com/nextest-rs/nextest/issues/16
#
# The MSRV jobs run only cargo check because different clippy versions can disagree on goals and
# running tests introduces dev dependencies which may require a higher MSRV than the bare package.
#
# If the workspace uses debug_assertions then we verify code twice, with it set to true or false.
# We always keep it true for external dependencies so that we can reuse the cache for faster builds.
#
# We don't save caches in the merge-group cases, because those caches will never be re-used (apart
# from the very rare cases where there are multiple PRs in the merge queue).
# This is because GitHub doesn't share caches between merge queues and the main branch.
name: CI
on:
pull_request:
merge_group:
# We run on push, even though the commit is the same as when we ran in merge_group.
# This allows the cache to be primed.
# See https://github.com/orgs/community/discussions/66430
push:
branches:
- main
jobs:
fmt:
name: formatting
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
components: rustfmt
- name: Run cargo fmt
run: cargo fmt --all --check
- name: Install ripgrep
run: |
sudo apt update
sudo apt install ripgrep
- name: Check copyright headers
run: bash .github/copyright.sh
- name: Check debug_assertions presence
run: bash .github/debug_assertions.sh
- name: Install cargo-rdme
uses: taiki-e/install-action@v2
with:
tool: cargo-rdme
- name: Run cargo rdme (masonry)
run: cargo rdme --check --heading-base-level=0 --workspace-project=masonry
- name: Run cargo rdme (tree_arena)
run: cargo rdme --check --heading-base-level=0 --workspace-project=tree_arena
clippy-stable:
name: cargo clippy
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [windows-latest, macos-latest, ubuntu-latest]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
components: clippy
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Install native dependencies
if: runner.os == 'Linux'
run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Run cargo clippy
run: cargo hack clippy --workspace --locked --profile ci --optional-deps --each-feature -- -D warnings
- name: Run cargo clippy (auxiliary)
run: cargo hack clippy --workspace --locked --profile ci --optional-deps --each-feature --tests --benches --examples -- -D warnings
- name: Run cargo clippy (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack clippy --workspace --locked --profile ci --optional-deps --each-feature -- -D warnings
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
- name: Run cargo clippy (auxiliary) (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack clippy --workspace --locked --profile ci --optional-deps --each-feature --tests --benches --examples -- -D warnings
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
clippy-stable-wasm:
name: cargo clippy (wasm32)
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
targets: wasm32-unknown-unknown
components: clippy
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Run cargo clippy
run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature -- -D warnings
- name: Run cargo clippy (auxiliary)
run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature --tests --benches --examples -- -D warnings
- name: Run cargo clippy (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature -- -D warnings
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
- name: Run cargo clippy (auxiliary) (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature --tests --benches --examples -- -D warnings
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
prime-lfs-cache:
name: Prime LFS Cache
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Cache git LFS
id: lfs-cache
uses: actions/cache@v4
with:
path: .git/lfs
# The files stored in git lfs are all in this folder
key: masonry-lfs-${{ hashFiles('masonry/src/widget/screenshots/*.png') }}
restore-keys: masonry-lfs-
enableCrossOsArchive: true
- name: Fetch LFS data
if: ${{ steps.lfs-cache.outputs.cache-hit != 'true' }}
run: git lfs fetch
test-stable:
name: cargo test
needs: prime-lfs-cache
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [windows-latest, macos-latest, ubuntu-latest]
include:
- os: windows-latest
# TODO: It should be possible to get WARP working here
skip_gpu: '1'
- os: macos-latest
skip_gpu: ''
- os: ubuntu-latest
skip_gpu: ''
steps:
- name: Checkout repository
uses: actions/checkout@v4
# We intentionally do not use lfs: true here, instead using the caching method to save LFS bandwidth.
- name: Restore LFS cache
id: lfs-cache
uses: actions/cache/restore@v4
with:
path: .git/lfs
# The files stored in git lfs are all in this folder
key: masonry-lfs-${{ hashFiles('masonry/src/widget/screenshots/*.png') }}
enableCrossOsArchive: true
- name: Checkout LFS files
run: git lfs checkout
continue-on-error: true
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
- name: Install native dependencies
if: runner.os == 'Linux'
run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
# Adapted from https://github.com/bevyengine/bevy/blob/b446374392adc70aceb92621b080d1a6cf7a7392/.github/workflows/validation-jobs.yml#L74-L79
- name: Install xvfb, llvmpipe and lavapipe
if: runner.os == 'Linux'
# https://launchpad.net/~kisak/+archive/ubuntu/turtle
run: |
sudo apt-get update -y -qq
sudo add-apt-repository ppa:kisak/turtle -y
sudo apt-get update
sudo apt install -y xvfb libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
- name: Install cargo-nextest
uses: taiki-e/install-action@v2
with:
tool: cargo-nextest
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Run cargo nextest
run: cargo nextest run --workspace --locked --all-features --no-fail-fast
env:
# We do not run the masonry render tests on platforms without a working GPU,
# because those require Vello rendering to be working
# See also https://github.com/linebender/vello/pull/610
SKIP_RENDER_TESTS: ${{ matrix.skip_gpu }}
- name: Upload test results due to failure
uses: actions/upload-artifact@v4
if: failure()
with:
name: masonry-snapshot-tests-${{ matrix.os }}
path: masonry/src/widget/screenshots
- name: Run cargo test --doc
run: cargo test --doc --workspace --locked --all-features --no-fail-fast
test-stable-wasm:
name: cargo test (wasm32)
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
targets: wasm32-unknown-unknown
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
# TODO: Find a way to make tests work. Until then the tests are merely compiled.
- name: Run cargo test --no-run
run: cargo test --workspace ${{ env.NO_WASM_PKGS }} --locked --target wasm32-unknown-unknown --all-features --no-run
check-stable-android:
name: cargo check (aarch64-android)
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_STABLE_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_STABLE_VER }}
targets: aarch64-linux-android
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Install cargo-apk
run: cargo install cargo-apk
- name: Run cargo apk check
run: cargo apk check ${{ env.ANDROID_TARGETS }}
env:
# This is a bit of a hack, but cargo apk doesn't seem to allow customising this otherwise
RUSTFLAGS: '-D warnings'
check-msrv:
name: cargo check (msrv)
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [windows-latest, macos-latest, ubuntu-latest]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_MIN_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_MIN_VER }}
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Install native dependencies
if: runner.os == 'Linux'
run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Run cargo check
run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} --locked --profile ci --optional-deps --each-feature
- name: Run cargo check (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} --locked --profile ci --optional-deps --each-feature
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
check-msrv-wasm:
name: cargo check (msrv) (wasm32)
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust ${{ env.RUST_MIN_VER }}
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_MIN_VER }}
targets: wasm32-unknown-unknown
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
- name: Run cargo check
run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
- name: Run cargo check (no debug_assertions)
if: env.USING_DEBUG_ASSERTIONS == 'true'
run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WASM_PKGS }} --locked --profile ci --target wasm32-unknown-unknown --optional-deps --each-feature
env:
CARGO_PROFILE_CI_DEBUG_ASSERTIONS: "false"
doc:
name: cargo doc
# NOTE: We don't have any platform specific docs in this workspace, so we only run on Ubuntu.
# If we get per-platform docs (win/macos/linux/wasm32/..) then doc jobs should match that.
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust nightly
uses: dtolnay/rust-toolchain@nightly
- name: Restore cache
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.event_name != 'merge_group' }}
# We test documentation using nightly to match docs.rs.
- name: Run cargo doc
run: cargo doc --workspace --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples
env:
RUSTDOCFLAGS: '--cfg docsrs -D warnings'
# If this fails, consider changing your text or adding something to .typos.toml.
typos:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Check typos
uses: crate-ci/[email protected]