Update README

This commit is contained in:
Benjy Weinberger 2024-10-29 17:51:59 -07:00
parent 5ed697a689
commit 911e6ff671

View File

@ -73,6 +73,10 @@ sensible defaults.
# Can be set to either "github" or "buildjet"
# default: "github"
cache-provider: ""
# Determines whether to cache the ~/.cargo/bin directory.
# default: "true"
cache-bin: ""
```
Further examples are available in the [.github/workflows](./.github/workflows/) directory.
@ -169,4 +173,7 @@ to see those details as well as further details related to caching operations.
## Known issues
- The cache cleaning process currently removes all the files from `~/.cargo/bin`
that were present before the action ran (for example `rustc`).
that were present before the action ran (for example `rustc`), by default.
This can be an issue on long-running self-hosted runners, where such state
is expected to be preserved across runs. You can work around this by setting
`cache-bin: "false"`.