From 20cd92f941d09df3e0fd8c078f5d16cf4c0e983a Mon Sep 17 00:00:00 2001 From: casjay Date: Sun, 21 Jun 2026 17:32:45 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Fix=20README=20accuracy:=20rust-?= =?UTF-8?q?workflow=20invocation=20and=20cache=20mount=20IDs=20?= =?UTF-8?q?=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two inaccuracies corrected: - rust-workflow is not run automatically on `docker run` with no args; the container starts in monitoring mode and rust-workflow must be called explicitly — update all examples to pass `rust-workflow` as the command argument and rename the section heading accordingly - Cache mount IDs in the BuildKit section were missing the per-arch suffix; corrected to apk-cache-, cargo-git-, rustup-downloads-, sccache-build- and added a note explaining why per-arch IDs are used in multi-platform builds - README.md: fix default-behavior section and cache mount ID table README.md --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cdcda7b..fbf73b5 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,11 @@ docker pull casjaysdev/rust:latest --- -## ⚡ Default behavior +## ⚡ rust-workflow -Running the container with no arguments automatically executes -**`rust-workflow`** — a four-step pipeline against the project mounted at -`/app`: +**`rust-workflow`** is a four-step pipeline included in the image. It must +be called explicitly — running the container with no arguments starts it in +monitoring mode, it does not execute `rust-workflow` automatically: ``` fmt check → clippy -D warnings → cargo test --all → cargo build --release @@ -30,7 +30,7 @@ fmt check → clippy -D warnings → cargo test --all → cargo build --re # run the full workflow against your project docker run --rm -it \ -v "$PWD:/app" \ - casjaysdev/rust:latest + casjaysdev/rust:latest rust-workflow ``` Override the working directory with `CARGO_WORKDIR`, or target a specific @@ -40,7 +40,7 @@ cross-compile triple with `CARGO_BUILD_TARGET`: docker run --rm -it \ -v "$PWD:/app" \ -e CARGO_BUILD_TARGET=aarch64-unknown-linux-musl \ - casjaysdev/rust:latest + casjaysdev/rust:latest rust-workflow ``` --- @@ -366,8 +366,10 @@ the image after a change does not re-download anything: docker build --tag casjaysdev/rust:local . ``` -Cache mount IDs: `apk-cache`, `cargo-registry`, `cargo-git`, -`rustup-downloads`, `sccache-build`. +Cache mount IDs: `apk-cache-`, `cargo-registry`, `cargo-git-`, +`rustup-downloads-`, `sccache-build-` (where `` is +`amd64` or `arm64` — per-arch IDs prevent cross-arch cache corruption in +multi-platform builds). ---