3
0
Fork 0
mirror of https://github.com/Swatinem/rust-cache synced 2025-11-17 13:07:40 +00:00

feat: Update cache key configuration option names for better clarity for their intended functionality

This commit is contained in:
Ryan-Brice 2025-10-31 16:07:47 +08:00
parent c21ebd7031
commit 70fec6c203
No known key found for this signature in database
GPG key ID: 3702BD1113AFDD13
3 changed files with 15 additions and 13 deletions

View file

@ -28,13 +28,15 @@ sensible defaults.
# default: empty
key: ""
# If the automatic `job`-based cache key should be used for the cache name.
# If the automatic `job`-based cache key should include the job id.
# default: "true"
use-job-key: ""
add-job-id-key: ""
# If the automatic `job`-based cache key should include a hash of the job's contents.
# Weather the a hash of the rust environment should be included in the cache key.
# This includes a hash of all Cargo.toml/Cargo.lock files, rust-toolchain files,
# and .cargo/config.toml files (if present), as well as the specified 'env-vars'.
# default: "true"
add-job-hash: ""
add-rust-environment-hash-key: ""
# A whitespace separated list of env-var *prefixes* who's value contributes
# to the environment cache key.