@zackees/soldr 0.7.7 → 0.7.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -77,6 +77,19 @@ That action:
|
|
|
77
77
|
- restores and saves a bounded hot Cargo target cache by default for no-op CI fast paths; set `target-cache: false` to disable it, `target-cache-mode: full` to opt into whole-target caching, or `target-dir:` to choose another target directory
|
|
78
78
|
- puts `soldr` on `PATH` for later steps
|
|
79
79
|
|
|
80
|
+
For existing workflows where rewriting every `cargo ...` command is high-friction, opt into Cargo PATH shims:
|
|
81
|
+
|
|
82
|
+
```yaml
|
|
83
|
+
- uses: zackees/setup-soldr@v0
|
|
84
|
+
with:
|
|
85
|
+
tool-shims: cargo
|
|
86
|
+
|
|
87
|
+
- run: cargo build --locked --release
|
|
88
|
+
- run: cargo test --locked
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The shim mode is off by default. When enabled, the action resolves the real Cargo binary before prepending its shim directory, then exports that real path for Soldr so `cargo ...` can safely trampoline into `soldr cargo ...` without recursive PATH lookup.
|
|
92
|
+
|
|
80
93
|
If your project pins Rust in `rust-toolchain.toml`, let the action read that file or pass the exact value with `toolchain:`. Do not preinstall a different generic toolchain such as `stable` and assume `soldr` will reconcile it later. The action exports `RUSTUP_TOOLCHAIN` after installation so later `cargo`, `rustc`, and `soldr cargo ...` steps stay on the toolchain it just installed instead of asking `rustup` to resolve a pinned file lazily.
|
|
81
94
|
|
|
82
95
|
On GitHub-hosted runners, this means you usually do not need a separate toolchain setup action for the normal path. The action still uses `rustup` under the hood today, but it bootstraps `rustup` itself when the runner does not already have it.
|