From 5c9efbe80083471239c4db10c541e7bacd04910b Mon Sep 17 00:00:00 2001 From: Gino Valente Date: Tue, 27 Dec 2022 21:03:02 -0800 Subject: [PATCH] Add README to bevy_reflect_compile_fail_tests --- crates/bevy_reflect_compile_fail_tests/README.md | 7 +++++++ tools/ci/src/main.rs | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 crates/bevy_reflect_compile_fail_tests/README.md diff --git a/crates/bevy_reflect_compile_fail_tests/README.md b/crates/bevy_reflect_compile_fail_tests/README.md new file mode 100644 index 0000000000000..52faa4f1d6034 --- /dev/null +++ b/crates/bevy_reflect_compile_fail_tests/README.md @@ -0,0 +1,7 @@ +# Compile fail tests for bevy_reflect + +This crate is separate from `bevy_reflect` and not part of the Bevy workspace in order to not fail `crater` tests for +Bevy. +The tests assert on the exact compiler errors and can easily fail for new Rust versions due to updated compiler errors (e.g. changes in spans). + +The `CI` workflow executes these tests on the stable rust toolchain (see [tools/ci](../../tools/ci/src/main.rs)). diff --git a/tools/ci/src/main.rs b/tools/ci/src/main.rs index 9d20e6ccaa66d..4fad887d3a974 100644 --- a/tools/ci/src/main.rs +++ b/tools/ci/src/main.rs @@ -100,7 +100,7 @@ fn main() { { // Reflect Compile Fail Tests // Run tests (they do not get executed with the workspace tests) - // - See crates/bevy_ecs_compile_fail_tests/README.md + // - See crates/bevy_reflect_compile_fail_tests/README.md let _subdir = sh.push_dir("crates/bevy_reflect_compile_fail_tests"); cmd!(sh, "cargo test --target-dir ../../target") .run()