summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2023-03-28 17:50:36 -0400
committerNick Gerace <nickagerace@gmail.com>2023-04-07 13:44:47 -0400
commitf3a4c1563218ac35f8ecfe131de9eb8c50292a9e (patch)
treeb949bb567eaebc108b118d65485d7b4e5eac3c6f /docs
parentbb91ee33ca811f8cf28791710c40e8c4fe0b0aa3 (diff)
downloadgfold-f3a4c1563218ac35f8ecfe131de9eb8c50292a9e.zip
Restore cargo xtask
Primary: - Restore cargo xtask to the repository - Polish "size" and "loose-bench" tasks and integrate them with cargo xtask - Update documentation to reflect new xtask changes - Move ci to use cargo xtask Secondary: - Remove unneeded run from gfold test Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/DEVELOPING.md49
-rw-r--r--docs/RELEASE.md6
2 files changed, 5 insertions, 50 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
index f13e2dd..fa369bd 100644
--- a/docs/DEVELOPING.md
+++ b/docs/DEVELOPING.md
@@ -2,50 +2,9 @@
This document contains information related to development.
-## Preparing Changes
+## `cargo xtask`
-First, update dependencies and tidy your changes.
+This repository uses the [`cargo-xtask`](https://github.com/matklad/cargo-xtask) pattern for local development
+and automation.
-```shell
-cargo fmt
-cargo update
-cargo fix --edition-idioms --allow-dirty --allow-staged
-cargo clippy --all-features --all-targets --no-deps
-```
-
-Now, ensure that lints, tests, and builds succeed.
-
-```shell
-cargo fmt --all -- --check
-cargo build --all-targets
-cargo clippy -- -D warnings
-RUSTDOCFLAGS="-Dwarnings" cargo doc --all --no-deps
-cargo test -- --nocapture
-```
-
-If you'd like to mass "fix" everything, you should commit/save existing work and execute the following:
-
-```shell
-cargo fix --all-targets --all-features --allow-dirty --allow-staged
-cargo clippy --fix --all-features --all-targets --allow-dirty --allow-staged
-```
-
-## Running Performance Tests
-
-See available packages with the following command:
-
-```shell
-cargo run -p
-```
-
-## Optional Checks
-
-The following checks are optional and should be run occasionally.
-
-```shell
-# This command requires a nightly toolchain to be installed.
-cargo +nightly udeps
-cargo bloat --release
-cargo bloat --release --crates
-cargo audit
-``` \ No newline at end of file
+To see what commands are available, execute `cargo xtask` from the root of the repository. \ No newline at end of file
diff --git a/docs/RELEASE.md b/docs/RELEASE.md
index 4b87ee0..8b36897 100644
--- a/docs/RELEASE.md
+++ b/docs/RELEASE.md
@@ -13,11 +13,7 @@ Steps should be executed in sequential order.
- [ ] Verify that everything looks/works as expected:
```shell
-cargo fmt --all -- --check
-cargo clippy -- -D warnings
-cargo test
-RUSTDOCFLAGS="-Dwarnings" cargo doc --all --no-deps
-cargo build --all-targets
+cargo xtask ci
```
- [ ] Create and _do not merge_ a commit with the following message: `Update to <tag>`