buildrush/Build_Rush Cache
Drop-in replacement for actions/cache@v5 backed by Build_Rush.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | A list of files, directories, and wildcard patterns to cache and restore | yes | — |
| key | An explicit key for restoring and saving the cache | yes | — |
| restore-keys | An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case. | no | — |
| upload-chunk-size | The chunk size used to split up large files during upload, in bytes | no | — |
| enableCrossOsArchive | An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms | no | false |
| fail-on-cache-miss | Fail the workflow if cache entry is not found | no | false |
| lookup-only | Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache | no | false |
| audience | OIDC audience to mint. Defaults to https://cache.buildrush.io (production cache service). | no | https://cache.buildrush.io |
| fallback | Build_Rush fallback policy when cache service is unavailable: github (default) | skip | fail. | no | github |
| compression | Build_Rush-specific. Compression for the cache archive: zstd-fast (default, fastest) | zstd (balanced, better ratio) | none (store uncompressed). zstd-fast and zstd interoperate within a key; none uses a separate cache namespace. | no | zstd-fast |
| verbose | Build_Rush-specific. Print debug-level diagnostics to the step log (HTTP statuses, retries, telemetry outcome). Defaults to false. | no | false |
Outputs
| name | description |
|---|---|
| cache-hit | A boolean value to indicate an exact match was found for the primary key |
| buildrush-reason | Build_Rush fallback reason code (empty string if the cache service was reached successfully). |