5241e09671
# Objective - Fixes #17960 ## Solution - Followed the [edition upgrade guide](https://doc.rust-lang.org/edition-guide/editions/transitioning-an-existing-project-to-a-new-edition.html) ## Testing - CI --- ## Summary of Changes ### Documentation Indentation When using lists in documentation, proper indentation is now linted for. This means subsequent lines within the same list item must start at the same indentation level as the item. ```rust /* Valid */ /// - Item 1 /// Run-on sentence. /// - Item 2 struct Foo; /* Invalid */ /// - Item 1 /// Run-on sentence. /// - Item 2 struct Foo; ``` ### Implicit `!` to `()` Conversion `!` (the never return type, returned by `panic!`, etc.) no longer implicitly converts to `()`. This is particularly painful for systems with `todo!` or `panic!` statements, as they will no longer be functions returning `()` (or `Result<()>`), making them invalid systems for functions like `add_systems`. The ideal fix would be to accept functions returning `!` (or rather, _not_ returning), but this is blocked on the [stabilisation of the `!` type itself](https://doc.rust-lang.org/std/primitive.never.html), which is not done. The "simple" fix would be to add an explicit `-> ()` to system signatures (e.g., `|| { todo!() }` becomes `|| -> () { todo!() }`). However, this is _also_ banned, as there is an existing lint which (IMO, incorrectly) marks this as an unnecessary annotation. So, the "fix" (read: workaround) is to put these kinds of `|| -> ! { ... }` closuers into variables and give the variable an explicit type (e.g., `fn()`). ```rust // Valid let system: fn() = || todo!("Not implemented yet!"); app.add_systems(..., system); // Invalid app.add_systems(..., || todo!("Not implemented yet!")); ``` ### Temporary Variable Lifetimes The order in which temporary variables are dropped has changed. The simple fix here is _usually_ to just assign temporaries to a named variable before use. ### `gen` is a keyword We can no longer use the name `gen` as it is reserved for a future generator syntax. This involved replacing uses of the name `gen` with `r#gen` (the raw-identifier syntax). ### Formatting has changed Use statements have had the order of imports changed, causing a substantial +/-3,000 diff when applied. For now, I have opted-out of this change by amending `rustfmt.toml` ```toml style_edition = "2021" ``` This preserves the original formatting for now, reducing the size of this PR. It would be a simple followup to update this to 2024 and run `cargo fmt`. ### New `use<>` Opt-Out Syntax Lifetimes are now implicitly included in RPIT types. There was a handful of instances where it needed to be added to satisfy the borrow checker, but there may be more cases where it _should_ be added to avoid breakages in user code. ### `MyUnitStruct { .. }` is an invalid pattern Previously, you could match against unit structs (and unit enum variants) with a `{ .. }` destructuring. This is no longer valid. ### Pretty much every use of `ref` and `mut` are gone Pattern binding has changed to the point where these terms are largely unused now. They still serve a purpose, but it is far more niche now. ### `iter::repeat(...).take(...)` is bad New lint recommends using the more explicit `iter::repeat_n(..., ...)` instead. ## Migration Guide The lifetimes of functions using return-position impl-trait (RPIT) are likely _more_ conservative than they had been previously. If you encounter lifetime issues with such a function, please create an issue to investigate the addition of `+ use<...>`. ## Notes - Check the individual commits for a clearer breakdown for what _actually_ changed. --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>
463 lines
16 KiB
YAML
463 lines
16 KiB
YAML
name: CI
|
|
|
|
on:
|
|
merge_group:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
- release-*
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
CARGO_INCREMENTAL: 0
|
|
CARGO_PROFILE_TEST_DEBUG: 0
|
|
CARGO_PROFILE_DEV_DEBUG: 0
|
|
# If nightly is breaking CI, modify this variable to target a specific nightly version.
|
|
NIGHTLY_TOOLCHAIN: nightly
|
|
RUSTFLAGS: "-D warnings"
|
|
|
|
concurrency:
|
|
group: ${{github.workflow}}-${{github.ref}}
|
|
cancel-in-progress: ${{github.event_name == 'pull_request'}}
|
|
|
|
jobs:
|
|
build:
|
|
strategy:
|
|
matrix:
|
|
os: [windows-latest, ubuntu-latest, macos-latest]
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-build-stable-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
- name: Build & run tests
|
|
# See tools/ci/src/main.rs for the commands this runs
|
|
run: cargo run -p ci -- test
|
|
env:
|
|
RUSTFLAGS: "-C debuginfo=0 -D warnings"
|
|
|
|
ci:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-ci-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
components: rustfmt, clippy
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
with:
|
|
wayland: true
|
|
xkb: true
|
|
- name: CI job
|
|
# See tools/ci/src/main.rs for the commands this runs
|
|
run: cargo run -p ci -- lints
|
|
|
|
miri:
|
|
runs-on: macos-latest
|
|
timeout-minutes: 60
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-miri-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@master
|
|
with:
|
|
toolchain: ${{ env.NIGHTLY_TOOLCHAIN }}
|
|
components: miri
|
|
- name: CI job
|
|
# To run the tests one item at a time for troubleshooting, use
|
|
# cargo --quiet test --lib -- --list | sed 's/: test$//' | MIRIFLAGS="-Zmiri-disable-isolation -Zmiri-disable-weak-memory-emulation" xargs -n1 cargo miri test -p bevy_ecs --lib -- --exact
|
|
run: cargo miri test -p bevy_ecs
|
|
env:
|
|
# -Zrandomize-layout makes sure we dont rely on the layout of anything that might change
|
|
RUSTFLAGS: -Zrandomize-layout
|
|
# https://github.com/rust-lang/miri#miri--z-flags-and-environment-variables
|
|
# -Zmiri-disable-isolation is needed because our executor uses `fastrand` which accesses system time.
|
|
# -Zmiri-ignore-leaks is necessary because a bunch of tests don't join all threads before finishing.
|
|
MIRIFLAGS: -Zmiri-ignore-leaks -Zmiri-disable-isolation
|
|
|
|
check-compiles:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: ci
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
crates/bevy_ecs_compile_fail_tests/target/
|
|
crates/bevy_reflect_compile_fail_tests/target/
|
|
key: ${{ runner.os }}-cargo-check-compiles-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
toolchain: stable
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
- name: Check Compile
|
|
# See tools/ci/src/main.rs for the commands this runs
|
|
run: cargo run -p ci -- compile
|
|
check-compiles-no-std:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: ci
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
crates/bevy_ecs_compile_fail_tests/target/
|
|
crates/bevy_reflect_compile_fail_tests/target/
|
|
key: ${{ runner.os }}-cargo-check-compiles-no-std-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
targets: x86_64-unknown-none
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
- name: Check Compile
|
|
run: cargo run -p ci -- compile-check-no-std
|
|
|
|
build-wasm:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: build
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ubuntu-assets-cargo-build-wasm-stable-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
target: wasm32-unknown-unknown
|
|
- name: Check wasm
|
|
run: cargo check --target wasm32-unknown-unknown
|
|
|
|
build-wasm-atomics:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: build
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ubuntu-assets-cargo-build-wasm-nightly-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@master
|
|
with:
|
|
toolchain: ${{ env.NIGHTLY_TOOLCHAIN }}
|
|
targets: wasm32-unknown-unknown
|
|
components: rust-src
|
|
- name: Check wasm
|
|
run: cargo check --target wasm32-unknown-unknown -Z build-std=std,panic_abort
|
|
env:
|
|
RUSTFLAGS: "-C target-feature=+atomics,+bulk-memory -D warnings"
|
|
|
|
markdownlint:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: check-missing-features-in-docs
|
|
if: always()
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
# Full git history is needed to get a proper list of changed files within `super-linter`
|
|
fetch-depth: 0
|
|
- name: Run Markdown Lint
|
|
uses: docker://ghcr.io/github/super-linter:slim-v4
|
|
env:
|
|
MULTI_STATUS: false
|
|
VALIDATE_ALL_CODEBASE: false
|
|
VALIDATE_MARKDOWN: true
|
|
DEFAULT_BRANCH: main
|
|
|
|
toml:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: Install taplo
|
|
run: cargo install taplo-cli --locked
|
|
- name: Run Taplo
|
|
id: taplo
|
|
run: taplo fmt --check --diff
|
|
- name: Taplo info
|
|
if: failure()
|
|
run: |
|
|
echo 'To fix toml fmt, please run `taplo fmt`.'
|
|
echo 'To check for a diff, run `taplo fmt --check --diff`.'
|
|
echo 'You can find taplo here: https://taplo.tamasfe.dev/'
|
|
echo 'Or if you use VSCode, use the `Even Better Toml` extension.'
|
|
echo 'You can find the extension here: https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml'
|
|
|
|
typos:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Check for typos
|
|
uses: crate-ci/typos@v1.29.7
|
|
- name: Typos info
|
|
if: failure()
|
|
run: |
|
|
echo 'To fix typos, please run `typos -w`'
|
|
echo 'To check for a diff, run `typos`'
|
|
echo 'You can find typos here: https://crates.io/crates/typos'
|
|
echo 'if you use VSCode, you can also install `Typos Spell Checker'
|
|
echo 'You can find the extension here: https://marketplace.visualstudio.com/items?itemName=tekumara.typos-vscode'
|
|
|
|
run-examples-macos-metal:
|
|
runs-on: macos-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: Disable audio
|
|
# Disable audio through a patch. on github m1 runners, audio timeouts after 15 minutes
|
|
run: git apply --ignore-whitespace tools/example-showcase/disable-audio.patch
|
|
- name: Run examples
|
|
run: |
|
|
for example in .github/example-run/*.ron; do
|
|
example_name=`basename $example .ron`
|
|
echo -n $example_name > last_example_run
|
|
echo "running $example_name - "`date`
|
|
time TRACE_CHROME=trace-$example_name.json CI_TESTING_CONFIG=$example cargo run --example $example_name --features "bevy_ci_testing,trace,trace_chrome"
|
|
sleep 10
|
|
if [ `find ./ -maxdepth 1 -name 'screenshot-*.png' -print -quit` ]; then
|
|
mkdir screenshots-$example_name
|
|
mv screenshot-*.png screenshots-$example_name/
|
|
fi
|
|
done
|
|
mkdir traces && mv trace*.json traces/
|
|
mkdir screenshots && mv screenshots-* screenshots/
|
|
- name: save traces
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: example-traces-macos
|
|
path: traces
|
|
- name: Save PR number
|
|
if: ${{ github.event_name == 'pull_request' }}
|
|
run: |
|
|
echo ${{ github.event.number }} > ./screenshots/PR
|
|
- name: save screenshots
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: screenshots-macos
|
|
path: screenshots
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ failure() && github.event_name == 'pull_request' }}
|
|
with:
|
|
name: example-run-macos
|
|
path: example-run/
|
|
check-doc:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-check-doc-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
with:
|
|
wayland: true
|
|
xkb: true
|
|
- name: Build and check doc
|
|
# See tools/ci/src/main.rs for the commands this runs
|
|
run: cargo run -p ci -- doc
|
|
env:
|
|
RUSTFLAGS: "-C debuginfo=0 -D warnings"
|
|
# This currently report a lot of false positives
|
|
# Enable it again once it's fixed - https://github.com/bevyengine/bevy/issues/1983
|
|
# - name: Installs cargo-deadlinks
|
|
# run: cargo install --force cargo-deadlinks
|
|
# - name: Checks dead links
|
|
# run: cargo deadlinks --dir target/doc/bevy
|
|
# continue-on-error: true
|
|
|
|
check-missing-examples-in-docs:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: check for missing metadata
|
|
id: missing-metadata
|
|
run: cargo run -p build-templated-pages -- check-missing examples
|
|
- name: check for missing update
|
|
run: cargo run -p build-templated-pages -- update examples
|
|
- name: Check for modified files
|
|
id: missing-update
|
|
run: |
|
|
echo "if this step fails, run the following command and commit the changed file on your PR."
|
|
echo " > cargo run -p build-templated-pages -- update examples"
|
|
git diff --quiet HEAD --
|
|
- name: Save PR number
|
|
if: ${{ failure() && github.event_name == 'pull_request' }}
|
|
run: |
|
|
mkdir -p ./missing-examples
|
|
echo ${{ github.event.number }} > ./missing-examples/NR
|
|
- name: log failed task - missing metadata
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.missing-metadata.conclusion == 'failure' }}
|
|
run: touch ./missing-examples/missing-metadata
|
|
- name: log failed task - missing update
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.missing-update.conclusion == 'failure' }}
|
|
run: touch ./missing-examples/missing-update
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ failure() && github.event_name == 'pull_request' }}
|
|
with:
|
|
name: missing-examples
|
|
path: missing-examples/
|
|
|
|
check-missing-features-in-docs:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: check-missing-examples-in-docs
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: check for missing features
|
|
id: missing-features
|
|
run: cargo run -p build-templated-pages -- check-missing features
|
|
- name: check for missing update
|
|
run: cargo run -p build-templated-pages -- update features
|
|
- name: Check for modified files
|
|
id: missing-update
|
|
run: |
|
|
echo "if this step fails, run the following command and commit the changed file on your PR."
|
|
echo " > cargo run -p build-templated-pages -- update features"
|
|
git diff --quiet HEAD --
|
|
- name: Save PR number
|
|
if: ${{ failure() && github.event_name == 'pull_request' }}
|
|
run: |
|
|
mkdir -p ./missing-features
|
|
echo ${{ github.event.number }} > ./missing-features/NR
|
|
- name: log failed task - missing features
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.missing-features.conclusion == 'failure' }}
|
|
run: touch ./missing-features/missing-features
|
|
- name: log failed task - missing update
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.missing-update.conclusion == 'failure' }}
|
|
run: touch ./missing-features/missing-update
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ failure() && github.event_name == 'pull_request' }}
|
|
with:
|
|
name: missing-features
|
|
path: missing-features/
|
|
|
|
msrv:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
needs: build
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-msrv-${{ hashFiles('**/Cargo.toml') }}
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- name: get MSRV
|
|
id: msrv
|
|
run: |
|
|
msrv=`cargo metadata --no-deps --format-version 1 | jq --raw-output '.packages[] | select(.name=="bevy") | .rust_version'`
|
|
echo "msrv=$msrv" >> $GITHUB_OUTPUT
|
|
- uses: dtolnay/rust-toolchain@master
|
|
with:
|
|
toolchain: ${{ steps.msrv.outputs.msrv }}
|
|
- name: Install Linux dependencies
|
|
uses: ./.github/actions/install-linux-deps
|
|
- name: Run cargo check
|
|
id: check
|
|
run: cargo check
|
|
- name: Save PR number
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.check.conclusion == 'failure' }}
|
|
run: |
|
|
mkdir -p ./msrv
|
|
echo ${{ github.event.number }} > ./msrv/NR
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ failure() && github.event_name == 'pull_request' && steps.check.conclusion == 'failure' }}
|
|
with:
|
|
name: msrv
|
|
path: msrv/
|
|
|
|
check-bevy-internal-imports:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Check for internal Bevy imports
|
|
shell: bash
|
|
run: |
|
|
errors=""
|
|
for file in $(find examples tests -name '*.rs'); do
|
|
if grep -q "use bevy_" "$file"; then
|
|
errors+="ERROR: Detected internal Bevy import in $file\n"
|
|
fi
|
|
done
|
|
if [ -n "$errors" ]; then
|
|
echo -e "$errors"
|
|
echo " Avoid importing internal Bevy crates, they should not be used directly"
|
|
echo " Fix the issue by replacing 'bevy_*' with 'bevy'"
|
|
echo " Example: 'use bevy::sprite::Mesh2d;' instead of 'bevy_internal::sprite::Mesh2d;'"
|
|
exit 1
|
|
fi
|