Skip to content

Commit 4404c68

Browse files
committed
Add README to bevy_reflect_compile_fail_tests
1 parent bab2c01 commit 4404c68

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Compile fail tests for bevy_reflect
2+
3+
This crate is separate from `bevy_reflect` and not part of the Bevy workspace in order to not fail `crater` tests for
4+
Bevy.
5+
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).
6+
7+
The `CI` workflow executes these tests on the stable rust toolchain (see [tools/ci](../../tools/ci/src/main.rs)).

tools/ci/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ fn main() {
100100
{
101101
// Reflect Compile Fail Tests
102102
// Run tests (they do not get executed with the workspace tests)
103-
// - See crates/bevy_ecs_compile_fail_tests/README.md
103+
// - See crates/bevy_reflect_compile_fail_tests/README.md
104104
let _subdir = sh.push_dir("crates/bevy_reflect_compile_fail_tests");
105105
cmd!(sh, "cargo test --target-dir ../../target")
106106
.run()

0 commit comments

Comments
 (0)