Skip to content

Commit

Permalink
Move *ci-check.sh* location
Browse files Browse the repository at this point in the history
  • Loading branch information
allan2 committed Oct 5, 2024
1 parent f9ad2c6 commit 3530ed4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Any community member can review a PR.

#### Commit Squashing

There is no need to squash your commits manually. PRs are usually squash merged anyway.
There is no need to squash your commits manually.

### CI

Expand All @@ -70,7 +70,7 @@ Please ensure that your PR passes the CI checks:
- [Rustdoc](https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html)
links work

If you are on a *nix system, you can use the [`scripts/ci-check.sh`](scripts/ci-check.sh) script to quickly check if you pass the CI checks.
The [`ci-check.sh`](ci-check.sh) can help with this.

#### Add an entry to the changelog

Expand Down
14 changes: 8 additions & 6 deletions scripts/ci-check.sh → ci-check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,27 @@ set -e

MSRV="1.74.0"

echo "fmt check"
echo "MSRV set to $MSRV"

echo "cargo fmt"
cargo fmt --all --check

echo "clippy"
cargo clippy -q --all-features --all-targets --workspace -- -D warnings

echo "build docs"
echo "Building docs"
RUSTDOCFLAGS="--cfg docsrs -D warnings" cargo doc -q --no-deps --all-features --document-private-items

echo "build tests"
echo "Building tests"
cargo test -q --no-run

echo "running tests..."
echo "Running tests..."
cargo test -q > /dev/null

echo "build tests on msrv"
echo "Building tests on MSRV"
RUSTUP_TOOLCHAIN="$MSRV" cargo test -q --no-run

echo "running tests on msrv..."
echo "Running tests on MSRV..."
RUSTUP_TOOLCHAIN="$MSRV" cargo test -q > /dev/null

echo ">>>>>> ALL OK <<<<<<<<"

0 comments on commit 3530ed4

Please sign in to comment.