Skip to content

Document ways to run the Test action. #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PoignardAzur wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document ways to run the Test action. #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,20 @@ Divan `0.1.21` requires Rust `1.80.0` or later.

See [`#[divan::bench]`][bench_attr] for info on benchmark function registration.

## Checking benchmarks in CI

If you want to run each benchmarked function only once (to check that they don't panic without measuring their performance), you can run the benchmark runner crate with the `--test` parameter. You can do so by running either

```sh
cargo bench -- --test
```

or

```sh
cargo test --benches
```

## Examples

Practical example benchmarks can be found in the [`examples/benches`](https://github.com/nvzqz/divan/tree/main/examples/benches)
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ pub use crate::{alloc::AllocProfiler, benchmark::Bencher, divan::Divan};
/// ```
///
/// See [`#[divan::bench]`](macro@bench) for more examples.
///
/// To get more options for running benchmarks, see [`Divan`] type.
pub fn main() {
Divan::from_args().main();
}
Expand Down