From 84995e0d91a927aa8da027221d329f84446b8c9b Mon Sep 17 00:00:00 2001 From: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com> Date: Mon, 13 Mar 2023 16:43:13 +0530 Subject: [PATCH] Updated description of the lookup-only input for main action (#1130) * Updated description of the lookup-only input for main action * Update README.md Co-authored-by: Bishal Prasad * Update README.md --------- Co-authored-by: Bishal Prasad --- README.md | 2 +- restore/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6cb3df7..f71eb50 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. * `enableCrossOsArchive` - An optional boolean when enabled, allows Windows runners to save or restore caches that can be restored or saved respectively on other platforms. Default: `false` * `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false` -* `lookup-only` - Skip downloading cache. Only check if cache entry exists. Default: `false` +* `lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false` #### Environment Variables diff --git a/restore/README.md b/restore/README.md index f125af7..a7203e9 100644 --- a/restore/README.md +++ b/restore/README.md @@ -10,7 +10,7 @@ The restore action restores a cache. It works similarly to the `cache` action ex * `path` - A list of files, directories, and wildcard patterns to restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns. * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. * `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false` -* `lookup-only` - Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache. Default: `false` +* `lookup-only` - If true, only checks if cache entry exists and skips download. Default: `false` ### Outputs