You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarify that the restore-keys input is a string in the docs (#1434)
* Fix Description for restore-keys at Readme
As previously the restore-keys were defined as an ordered lists which is
wrong as per the issue description where the actual format is a
multi-line string with one key per line.
* Added a space between the sentence of restore-keys description
While at the PR review it's been identified there's a need for a space
between the sentence
```
An ordered multiline string listing the prefix-matched keys,that are
used for restoring stale cache if no cache hit occurred for key.
```
where it's written as "prefix-matched keys,that are" this commit will
address the review comment and introduce a space between
"prefix-matched keys, that are" and change the sentence to
```
An ordered multiline string listing the prefix-matched keys, that are
used for restoring stale cache if no cache hit occurred for key.
```
* Change restore-keys description at cache/restore/action.yml and cache/action.yml
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir
54
54
55
55
*`key` - An explicit key for a cache entry. See [creating a cache key](#creating-a-cache-key).
56
56
*`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.
57
-
*`restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key.
57
+
*`restore-keys` - An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key.
58
58
*`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`
59
59
*`fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false`
60
60
*`lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false`
Copy file name to clipboardExpand all lines: action.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ inputs:
9
9
description: 'An explicit key for restoring and saving the cache'
10
10
required: true
11
11
restore-keys:
12
-
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.'
12
+
description: 'An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.'
13
13
required: false
14
14
upload-chunk-size:
15
15
description: 'The chunk size used to split up large files during upload, in bytes'
Copy file name to clipboardExpand all lines: restore/action.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ inputs:
9
9
description: 'An explicit key for restoring the cache'
10
10
required: true
11
11
restore-keys:
12
-
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.'
12
+
description: 'An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.'
13
13
required: false
14
14
enableCrossOsArchive:
15
15
description: 'An optional boolean when enabled, allows windows runners to restore caches that were saved on other platforms'
0 commit comments