Skip to content

Commit

Permalink
Merge pull request #1425 from hannobraun/just
Browse files Browse the repository at this point in the history
Update `justfile`
  • Loading branch information
hannobraun authored Dec 7, 2022
2 parents 8c7dbc3 + a2d6523 commit 42a8d4f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@ cargo test -p fj-kernel
You can run the full suite of checks and tests like this:

``` sh
just build
just ci
```

You can also run a lighter version that just checks for code correctness:
``` sh
just test
```

This requires [`just`](https://crates.io/crates/just), which you can install like this:
Expand Down
21 changes: 18 additions & 3 deletions justfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
export RUSTDOCFLAGS := "-D warnings"

build:
# Run all tests, including end-to-end export validation tests.
#
# This command is designed to be used regularly during CAD kernel development.
# It runs tests to check for code correctness, but accepts warnings in the code
# and does not check formatting or documentation.
#
# For a full build that mirrors the CI build, see `just ci`.
test:
cargo test --all-features
cargo run --package export-validator

# Run a full build that mirrors the CI build
#
# Basically, if this passes locally, then the CI build should pass too, once you
# submit your work as a pull request. Please note that the CI build is
# maintained separately from this file. Most deviations in behavior should
# probably be considered a bug in this file.
ci: test
cargo fmt --check
cargo clippy --all-features -- -D warnings
cargo test --all-features
cargo doc --no-deps --document-private-items --all-features --workspace
cargo run --package cross-compiler
cargo run --package export-validator

0 comments on commit 42a8d4f

Please sign in to comment.