Clarify that the restore-keys input is a string in the docs
#1434
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
webknjaz
reviewed
Jul 18, 2024
restore-keys input is a string in the docs
|
@bethanyj28, mind taking a look at this PR? |
webknjaz
approved these changes
Jul 19, 2024
joshmgross
approved these changes
Jul 31, 2024
joshmgross
reviewed
Jul 31, 2024
| @@ -54,7 +54,7 @@ If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are requir | |||
|
|
|||
| * `key` - An explicit key for a cache entry. See [creating a cache key](#creating-a-cache-key). | |||
| * `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. | |||
| * `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. | |||
| * `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. | |||
There was a problem hiding this comment.
Done @joshmgross Mind taking a relook?
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.
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.
```
2ba2e98
to
13f54a0
Compare
joshmgross
approved these changes
Aug 6, 2024
siddhantdange
pushed a commit
to buildpulse/cache
that referenced
this pull request
Oct 4, 2024
…s#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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously the description of
restore-keysconfusingly implied that it might accept a YAML list, which is wrong. This patch corrects that to say, it's a string.Closes #1173