History

BD103 f391522483 Test benchmarks in CI (#16987 ) # Objective - This reverts #16833, and completely goes against #16803. - Turns out running `cargo test --benches` runs each benchmark once, without timing it, just to ensure nothing panics. This is actually desired because we can use it to verify benchmarks are working correctly without all the time constraints of actual benchmarks. ## Solution - Add the `--benches` flag to the CI test command. ## Testing - `cargo run -p ci -- test`		2024-12-29 19:33:06 +00:00
..
benches	Test benchmarks in CI (#16987 )	2024-12-29 19:33:06 +00:00
src	Migrate reflection benchmarks to new naming system (#16986 )	2024-12-26 22:28:09 +00:00
Cargo.toml	Migrate reflection benchmarks to new naming system (#16986 )	2024-12-26 22:28:09 +00:00
README.md	Add benchmarks and `compile_fail` tests back to workspace (#16858 )	2024-12-21 22:30:29 +00:00

README.md

Bevy Benchmarks

This is a crate with a collection of benchmarks for Bevy.

Running benchmarks

Benchmarks can be run through Cargo:

# Run all benchmarks. (This will take a while!)
cargo bench -p benches

# Just compile the benchmarks, do not run them.
cargo bench -p benches --no-run

# Run the benchmarks for a specific crate. (See `Cargo.toml` for a complete list of crates
# tracked.)
cargo bench -p benches --bench ecs

# Filter which benchmarks are run based on the name. This will only run benchmarks whose name
# contains "name_fragment".
cargo bench -p benches -- name_fragment

# List all available benchmarks.
cargo bench -p benches -- --list

# Save a baseline to be compared against later.
cargo bench -p benches --save-baseline before

# Compare the current benchmarks against a baseline to find performance gains and regressions.
cargo bench -p benches --baseline before

Criterion

Bevy's benchmarks use Criterion. If you want to learn more about using Criterion for comparing performance against a baseline or generating detailed reports, you can read the Criterion.rs documentation.