Skip to content

Commit

Permalink
ci: add single script to run all CI checks locally
Browse files Browse the repository at this point in the history
  • Loading branch information
agostbiro committed Jun 30, 2023
1 parent 470c376 commit a077e8c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ Please use descriptive PR titles. We loosely follow the [conventional commits](h

Ensure the following are satisfied before opening a PR:
- Code is formatted with `rustfmt` by running `cargo fmt`
- Run `clippy`
- The exact command run by the CI is `cargo clippy --tests -- -Dclippy::all`
- Run tests with `cargo test`
- Test all examples with `./examples/test_all.sh`
- This must be done after the previous step
- Run all tests and linters with [./run-tests.sh](./run-tests.sh)
- Ensure any new functionality is adequately tested
- If any new public types or functions are added, ensure they have appropriate [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) documentation
8 changes: 8 additions & 0 deletions run-tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash

set -e

cargo fmt --check --all
cargo clippy --tests --all-features -- -Dclippy::all
cargo test --all --features unstable,legacy
./examples/test_all.sh

0 comments on commit a077e8c

Please sign in to comment.