2023-06-14 21:10:24 +08:00
|
|
|
#!/bin/bash
|
2023-08-17 06:44:16 +08:00
|
|
|
|
|
|
|
# Exit immediately if a command exits with a non-zero status.
|
|
|
|
set -e
|
|
|
|
|
2023-09-01 21:01:15 +08:00
|
|
|
# This script runs all `burn` checks locally. It may take around 15 minutes
|
|
|
|
# on the first run.
|
2023-08-15 05:43:21 +08:00
|
|
|
#
|
|
|
|
# Run `run-checks` using this command:
|
|
|
|
#
|
2023-11-03 02:30:07 +08:00
|
|
|
# ./run-checks.sh environment
|
2023-08-15 05:43:21 +08:00
|
|
|
#
|
|
|
|
# where `environment` can assume **ONLY** the following values:
|
|
|
|
#
|
|
|
|
# - `std` to perform checks using `libstd`
|
|
|
|
# - `no_std` to perform checks on an embedded environment using `libcore`
|
2023-08-17 06:44:16 +08:00
|
|
|
# - `typos` to check for typos in the codebase
|
2023-09-01 21:28:58 +08:00
|
|
|
# - `examples` to check the examples compile
|
2023-08-15 05:43:21 +08:00
|
|
|
#
|
2023-09-01 21:28:58 +08:00
|
|
|
# If no `environment` value has been passed, run all checks except examples.
|
2023-08-15 05:43:21 +08:00
|
|
|
|
|
|
|
# Run binary passing the first input parameter, who is mandatory.
|
|
|
|
# If the input parameter is missing or wrong, it will be the `run-checks`
|
|
|
|
# binary which will be responsible of arising an error.
|
2023-09-06 20:22:00 +08:00
|
|
|
cargo xtask run-checks $1
|