From 3767bf0386fab655782439a25c2326ace47f41c6 Mon Sep 17 00:00:00 2001 From: Albert Still Date: Fri, 26 Mar 2021 10:36:55 +1100 Subject: [PATCH] Improve restore-key documentation --- README.md | 3 ++- action.yml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07f12e8..d22bd4f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory * `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns. * `key` - An explicit key for restoring and saving the cache -* `restore-keys` - An ordered list of keys to use for restoring the cache if no cache hit occurred for key +* `restore-keys` - An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note +`cache-hit` returns false in this case. ### Outputs diff --git a/action.yml b/action.yml index 323a4bd..bc17d36 100644 --- a/action.yml +++ b/action.yml @@ -9,7 +9,7 @@ inputs: description: 'An explicit key for restoring and saving the cache' required: true restore-keys: - description: 'An ordered list of keys to use for restoring the cache if no cache hit occurred for key' + description: 'An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.' required: false upload-chunk-size: description: 'The chunk size used to split up large files during upload, in bytes'