From 911e6ff671964c20c1606b086d3f169643c23955 Mon Sep 17 00:00:00 2001 From: Benjy Weinberger Date: Tue, 29 Oct 2024 17:51:59 -0700 Subject: [PATCH] Update README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f33fca..59d684c 100644 --- a/README.md +++ b/README.md @@ -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"`.