mirror of
https://github.com/bevyengine/bevy
synced 2024-12-25 20:43:07 +00:00
a6b5f80715
# Objective Fixes #16610, related to #16702 ## Solution Upgrade typos and its configuration ## Testing - Did you test these changes? If so, how? No - Are there any parts that need more testing? No - How can other people (reviewers) test your changes? Is there anything specific they need to know? No - If relevant, what platforms did you test these changes on, and are there any important ones you can't test? Not applicable
461 lines
16 KiB
YAML
461 lines
16 KiB
YAML
name: CI
|
|
|
|
on:
|
|
merge_group:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
- release-*
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
# If nightly is breaking CI, modify this variable to target a specific nightly version.
|
|
NIGHTLY_TOOLCHAIN: nightly
|
|
|
|
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:
|
|
CARGO_INCREMENTAL: 0
|
|
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"
|
|
|
|
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.28.2
|
|
- 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@master
|
|
with:
|
|
toolchain: ${{ env.NIGHTLY_TOOLCHAIN }}
|
|
- 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:
|
|
CARGO_INCREMENTAL: 0
|
|
RUSTFLAGS: "-C debuginfo=0 --cfg docsrs_dep"
|
|
# 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
|
|
- 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
|
|
- 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') }}
|
|
- 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
|