Convert run-checks script into a Rust binary

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 
 ### Checklist
 
-- [ ] Confirm that `run-checks.sh` has been executed.
+- [ ] Confirm that `run-checks` script has been executed.
 
 ### Related Issues/PRs
 

.gitignore

@@ -6,4 +6,8 @@ Cargo.lock
 .cargo/config.toml
 
 .idea
-.vscode
+.vscode
+
+# Ignore binaries contained in the `scripts` directory
+scripts/publish
+scripts/run-checks

README.md

@@ -285,7 +285,30 @@ recommended to read our
 [architecture document](https://github.com/burn-rs/burn/tree/main/ARCHITECTURE.md), which explains
 our architectural decisions. Please see more details in our [contributing guide](/CONTRIBUTING.md).
 
-## CI
+## Continuous Integration
+
+### Run checks
+
+On Unix systems, run `run-checks.sh` using this command
+
+```
+run-checks.sh environment
+```
+
+On Windows systems, run `run-checks.ps1` using this command:
+
+```
+run-checks.ps1 environment
+```
+
+The `environment` argument can assume **ONLY** the following values:
+
+- `std` to perform checks using `libstd`
+- `no_std` to perform checks on an embedded environment using `libcore`
+
+If no `environment` value has been passed, run both `std` and `no_std` checks.
+
+## Continuous Deployment
 
 ### Publish crates
 
@@ -295,6 +318,15 @@ Compile `scripts/publish.rs` using this command:
 rustc scripts/publish.rs --crate-type bin --out-dir scripts
 ```
 
+Run `scripts/publish` using this command
+
+```
+./scripts/publish crate_name
+```
+
+where `crate_name` is the name of the crate to publish
+
+
 ## Disclaimer
 
 Burn is currently in active development, and there will be breaking changes. While any resulting

run-checks.ps1

@@ -0,0 +1,20 @@
+# This script runs all `burn` checks locally
+#
+# Run `run-checks` using this command:
+#
+# ./scripts/run-checks environment
+#
+# 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`
+#
+# If no `environment` value has been passed, run both `std` and `no_std` checks.
+
+# Compile run-checks binary
+rustc scripts/run-checks.rs --crate-type bin --out-dir scripts
+
+# 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.
+./scripts/run-checks $args[0]

run-checks.sh

@@ -1,144 +1,22 @@
 #!/bin/bash
-
-# This script is run before a PR is created.
-# It is used to check that the code compiles and passes all tests.
-# It is also used to check that the code is formatted correctly and passes clippy.
-
-# Usage: ./run-checks.sh {all|no_std|std} (default: all)
-
-# Exit immediately if a command exits with a non-zero status.
-set -euo pipefail
-
-# Function to handle errors
-error_handler() {
-    local exit_status=$?
-    local line_number=$1
-    local command=$2
-
-    echo "Error on line $line_number"
-    echo "Command '$command' exited with status $exit_status"
-}
-
-# Signal trap to call error_handler when a command fails
-trap 'error_handler $LINENO $BASH_COMMAND' ERR
-
-# Function to build and test no_std
-build_and_test_no_std() {
-    local dir=$1
-
-    echo "$dir"
-    cd $dir || exit
-
-    echo "Build without defaults"
-    cargo build --no-default-features
-
-    echo "Test without defaults"
-    cargo test --no-default-features
-
-    echo "Build for WebAssembly"
-    cargo build --no-default-features --target wasm32-unknown-unknown
-
-    echo "Build for ARM"
-    cargo build --no-default-features --target thumbv7m-none-eabi
-
-    cd .. || exit
-}
-
-# Function to build and test all features
-build_and_test_all_features() {
-    local dir=$1
-
-    echo "$dir"
-    cd $dir || exit
-
-    echo "Build with all defaults"
-    cargo build --all-features
-
-    echo "Test with all features"
-    cargo test --all-features
-
-    echo "Check documentation with all features"
-    cargo doc --all-features
-
-    cd .. || exit
-}
-
-# Set RUSTDOCFLAGS to treat warnings as errors for the documentation build
-export RUSTDOCFLAGS="-D warnings"
-
-# Run the checks for std and all features with std
-std_func() {
-    echo "Running std checks"
-
-    cargo build --workspace
-    cargo test --workspace
-    cargo fmt --check --all
-    cargo clippy -- -D warnings
-    cargo doc --workspace
-
-    # all features
-    echo "Running all-features checks"
-    build_and_test_all_features "burn-dataset"
-
-    cd burn-core || exit
-
-    echo "Test burn-core with tch backend"
-    cargo test --features test-tch
-
-    echo "Test burn-core with wgpu backend"
-    cargo test --features test-wgpu
-
-    cd .. || exit
-}
-
-# Run the checks for no_std
-no_std_func() {
-    echo "Running no_std checks"
-
-    # Add wasm32 target for compiler.
-    rustup target add wasm32-unknown-unknown
-    rustup target add thumbv7m-none-eabi
-
-    build_and_test_no_std "burn"
-    build_and_test_no_std "burn-core"
-    build_and_test_no_std "burn-common"
-    build_and_test_no_std "burn-tensor"
-    build_and_test_no_std "burn-ndarray"
-    build_and_test_no_std "burn-no-std-tests"
-}
-
-# Save the script start time
-start_time=$(date +%s)
-
-# If no arguments were supplied or if it's empty, set the default as 'all'
-if [ -z "${1-}" ]; then
-    arg="all"
-else
-    arg=$1
-fi
-
-# Check the argument and call the appropriate functions
-case $arg in
-all)
-    no_std_func
-    std_func
-    ;;
-no_std)
-    no_std_func
-    ;;
-std)
-    std_func
-    ;;
-*)
-    echo "Error: Invalid argument"
-    echo "Usage: $0 {all|no_std|std}"
-    exit 1
-    ;;
-esac
-
-# Calculate and print the script execution time
-end_time=$(date +%s)
-execution_time=$((end_time - start_time))
-echo "Script executed in $execution_time seconds."
-
-exit 0
+#
+# This script runs all `burn` checks locally
+#
+# Run `run-checks` using this command:
+#
+# ./scripts/run-checks environment
+#
+# 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`
+#
+# If no `environment` value has been passed, run both `std` and `no_std` checks.
+
+# Compile run-checks binary
+rustc scripts/run-checks.rs --crate-type bin --out-dir scripts
+
+# 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.
+./scripts/run-checks $1