zackees/setup-soldr

Extraction-ready Soldr setup action. Installs one soldr binary, bootstraps rustup when needed, provisions the resolved Rust toolchain, and restores a cacheable runner-local Soldr root.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
version	Soldr version or tag to install. Defaults to the latest release.	no	""
repo	Release source repository override for extraction or local testing. Not part of the intended public setup-soldr@v0 beta contract.	no	zackees/soldr
cache	Restore and save the action-managed cache/state root across workflow runs.	no	true
cache-dir	Override the runner-local cache/state root used for Soldr, Cargo, and rustup state rehydrated by this action.	no	""
cache-key-suffix	Optional extra suffix appended to the cache key.	no	""
toolchain	Override the exact Rust toolchain channel string. When empty, toolchain-file is used if present, otherwise stable.	no	""
toolchain-file	Toolchain file to read when toolchain is not explicitly set.	no	rust-toolchain.toml
trust-mode	Optional value for SOLDR_TRUST_MODE.	no	""
build-cache	Restore and save the Soldr-owned zccache compilation artifact cache across workflow runs. Default "true"; the action restores the action-managed zccache cache root with a toolchain-scoped key and saves it at end-of-job, letting GitHub's own-branch -> PR base -> default-branch restore order seed feature-branch runs from the latest main-branch save without any repo-side configuration. Set to "false" to opt out.	no	true
target-cache	Restore and save the zccache-owned Rust artifact plan cache across workflow runs. Default "true"; target-cache-mode controls whether this is a bounded thin dependency-artifact cache or an explicit full target cache plan. Set to "false" to cache only zccache compilation artifacts.	no	true
target-cache-mode	Rust artifact cache mode. "thin" asks soldr to generate a bounded dependency-artifact plan for zccache by default. "full" asks zccache to cache the entire target-dir and should only be used for tightly scoped jobs. "off" disables target caching even when target-cache is true. The previous "hot" value is accepted as a deprecated alias for "thin".	no	thin
target-dir	Cargo target directory used in target-cache key shaping.	no	target
tool-shims	Optional PATH shim mode for existing workflows. Set to "cargo" to make later `cargo ...` steps run through `soldr cargo ...` without rewriting them. Default "false" leaves PATH unchanged.	no	false
native-cache	Default-on native C/C++ compiler caching for build-script work (e.g. bundled SQLite from `libsqlite3-sys`). When "true", soldr injects zccache as the `CC` / `CXX` wrapper so cc-rs invocations hit the same managed cache that rustc invocations do. Default "true"; set to "false" to write `SOLDR_NATIVE_CACHE=0` to the job env so later `soldr cargo ...` steps skip native compiler wrapping while keeping Rust caching intact. `soldr --no-cache cargo ...` is still the global kill-switch and overrides this input at command time.	no	true

Outputs

name	description
soldr-path	Installed Soldr binary path added to PATH for later steps.
soldr-version	Installed Soldr version reported by soldr version --json.
cache-dir	Runner-local cache/state root used by the action.
cache-hit	Whether the action restored an exact cache hit for the selected cache/state root.
build-cache-hit	Whether the action restored the Soldr-owned zccache compilation artifact cache. "true" for an exact key match, "false" for a restore-key fallback or no cache, empty string when `build-cache` is explicitly disabled.
target-cache-hit	Whether the action restored the Rust artifact plan cache. "true" for an exact key match, "false" for a restore-key fallback or no cache, empty string when `target-cache` is disabled.
target-cache-mode	Effective Rust artifact target cache mode.
toolchain	Exact Rust toolchain channel configured by rustup for the action.
tool-shims-dir	Directory containing generated tool shims when tool-shims is enabled.
native-cache-enabled	Effective native C/C++ compiler cache policy resolved by the action. "true" when soldr will inject zccache as the `CC` / `CXX` wrapper for later `soldr cargo ...` steps; "false" when the action wrote `SOLDR_NATIVE_CACHE=0` to the job env. The command-time kill-switch `soldr --no-cache cargo ...` is not reflected here because it overrides the action's policy at run time.