Add back quick and dirty just recipes
What the developer wrote
Authored by Nick Johnson
Add back quick and dirty just recipes
The "lint" and "sane" recipes are kept quick and queit for local
dev cycles. The "ci" recipe can be used to match a more extensive
CI task locally on failures.
What changed, and why it matters
This commit only renames and reorganizes developer helper recipes in a justfile (a build/task runner configuration). It changes command aliases like `test-stable` to `ci-stable`, adds quick local recipes such as `lint` and `sane`, and groups existing recipes. There is no change to the actual Rust Bitcoin library code, cryptography, network handling, or any code that end users or downstream applications rely on.
No security action needed. This is a routine developer-experience tooling change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies justfile only. It renames recipes (test-stable -> ci-stable, lint -> ci-lint, docs -> ci-docs, docsrs -> ci-docsrs, bench -> ci-bench), adds [group('ci')] and [group('scripts')] annotations, replaces per-crate check/fmt recipes with workspace-wide lint, sane, fmt, and docsrs recipes, and updates comments. No Rust source, dependencies, Cargo.toml, CI pipeline logic, or cryptographic code is touched.
Changed components
justfileInspect captured patch +32 / −12
diff --git a/justfile b/justfile
index 3ca6fda8..55bbe19a 100644
--- a/justfile
+++ b/justfile
@@ -9,55 +9,75 @@ _default:
@just --list
# Run the given CI task using maintainer tools.
+[group('ci')]
@ci task toolchain="stable" lock="recent":
{{justfile_directory()}}/contrib/ensure-maintainer-tools.sh
cp -f {{justfile_directory()}}/Cargo-{{lock}}.lock {{justfile_directory()}}/Cargo.lock
rustup run {{toolchain}} {{justfile_directory()}}/.maintainer-tools/ci/run_task.sh {{task}}
# Test workspace with stable toolchain.
-test-stable: (ci "stable")
+[group('ci')]
+ci-stable: (ci "stable")
# Lint workspace.
-lint: (ci "lint" NIGHTLY_VERSION)
+[group('ci')]
+ci-lint: (ci "lint" NIGHTLY_VERSION)
# Generate documentation.
-docs: (ci "docs")
+[group('ci')]
+ci-docs: (ci "docs")
# Generate documentation with nightly.
-docsrs: (ci "docsrs" NIGHTLY_VERSION)
+[group('ci')]
+ci-docsrs: (ci "docsrs" NIGHTLY_VERSION)
# Run benchmarks.
-bench: (ci "bench")
+[group('ci')]
+ci-bench: (ci "bench")
-# Sanity check given crates.
-@check +crates:
- cargo test --quiet -p {{replace(crates, " ", " -p ")}} --no-default-features
- cargo test --quiet -p {{replace(crates, " ", " -p ")}} --all-features
+# Quick workspace lint.
+@lint:
+ cargo +{{NIGHTLY_VERSION}} clippy --quiet --workspace --all-targets --all-features -- --deny warnings
-# Format given crates.
-@fmt +crates:
- cargo +{{NIGHTLY_VERSION}} fmt -p {{replace(crates, " ", " -p ")}}
+# Quick workspace sanity check.
+@sane: lint
+ cargo test --quiet --workspace --all-targets --no-default-features
+ cargo test --quiet --workspace --all-targets --all-features
+
+# Format workspace.
+@fmt:
+ cargo +{{NIGHTLY_VERSION}} fmt --all
+
+# Generate documentation (accepts cargo doc args, e.g. --open).
+@docsrs *flags:
+ RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" cargo +{{NIGHTLY_VERSION}} doc --all-features {{flags}}
# Check for API changes.
+[group('scripts')]
check-api:
{{justfile_directory()}}/contrib/check-for-api-changes.sh
# Query the current API.
+[group('scripts')]
@query-api crate command:
{{justfile_directory()}}/contrib/api.sh $1 $2
# Update the recent and minimal lock files.
+[group('scripts')]
update-lock-files:
{{justfile_directory()}}/contrib/update-lock-files.sh
# Install githooks.
+[group('scripts')]
githooks-install:
{{justfile_directory()}}/contrib/copy-githooks.sh
# Remove githooks.
+[group('scripts')]
githooks-remove:
{{justfile_directory()}}/contrib/copy-githooks.sh -r
# Generate a dependency tree for workspace crates.
+[group('scripts')]
gen-dep-tree:
{{justfile_directory()}}/contrib/gen-dep-tree.sh
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.