Clarify that the restore-keys input is a string in the docs
#1434
Conversation
This file contains hidden or 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
mmatl
added a commit
to ambi-robotics/cache
that referenced
this pull request
Jul 23, 2025
* update documentation to use <action>@v4 * Update README.md and use v4 of checkout action (actions#1437) Update examples to use latest available checkout action v4. * Explicit use bash for Windows (actions#1377) Co-authored-by: Josh Gross <joshmgross@github.com> * Fix cache-hit output when cache missed (actions#1404) * fix: cache-hit output * fix: Output chache hit timing * fix: Output chache hit timing --------- Co-authored-by: Josh Gross <joshmgross@github.com> * Clarify that the `restore-keys` input is a string in the docs (actions#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 * Add workflow file for publishing releases to immutable action package This workflow file publishes new action releases to the immutable action package of the same name as this repo. This is part of the Immutable Actions project which is not yet fully released to the public. First party actions like this one are part of our initial testing of this feature. * Deprecate `save-always` input (actions#1452) The `save-always` input added in v4 is not working as intended due to `post-if` expressions not supporting the input context. To avoid breaking users who have already added this input to their workflows, it is being deprecated now and will be removed in the next major version (v5). See actions#1315 for more details. * Fix typo: depening -> depending (actions#1462) Co-authored-by: Josh Gross <joshmgross@github.com> * restore action's README now references v4 instead of v3 (actions#1445) Co-authored-by: Josh Gross <joshmgross@github.com> * Prepare `4.1.0` release (actions#1464) * Restore original behavior of `cache-hit` output (actions#1467) * Restore original behavior of `cache-hit` output * Bump version to 4.1.1 * Add Bun example (actions#1456) * Add Bun example * Fix Bun Windows example * Revise `isGhes` logic * ran `npm run build` * appease the linter * added unit tests * Bump braces from 3.0.2 to 3.0.3 Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3. - [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md) - [Commits](micromatch/braces@3.0.2...3.0.3) --- updated-dependencies: - dependency-name: braces dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Create dependabot.yml * Prepare release 4.1.2 * Bump actions/checkout from 3 to 4 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/stale from 3 to 9 Bumps [actions/stale](https://github.com/actions/stale) from 3 to 9. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](actions/stale@v3...v9) --- updated-dependencies: - dependency-name: actions/stale dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/setup-node from 3 to 4 Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v3...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bump github/codeql-action from 2 to 3 Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v2...v3) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Upgrade @actions/cache to 4.0.0 * Update RELEASES.md * Upgrade @vercel/ncc to 0.38.3 * Upgrade @actions/core to 1.11.1 and other deps * Add licensed output * Add reviewed licensed packages * Add lodash to list of reviewed licenses * Add licensed output * Rerun CI * Add 3.4.0 release notes * Correct GitHub Spelling in caching-strategies.md (actions#1526) GitHub was spelled incorrectly 3 lines under the Understanding how to choose path section * docs: Make the "always save prime numbers" example more clear (actions#1525) * Update force deletion docs due a recent deprecation (actions#1500) * fix: update force deletion docs due a recent deprecation * fix: applied josh's suggestions --------- Co-authored-by: Josh Gross <joshmgross@github.com> * bump @actions/cache to v4.0.1 * Update publish-immutable-actions.yml * bump @actions/cache to v4.0.2, prep for v4.2.2 release * add changes * changed * mask whole url * debugging * type * artifact changes * update cache package to mask whole sas to the end of the line * mask * update * latest test before pr * updated cache with latest changes * updates * new package * update cache with main * Update to use the latest version of the cache package to obfuscate the SAS * Update releases.md * Update README.md * fix: fix --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: todgru <todgru@gmail.com> Co-authored-by: P. Ottlinger <ottlinger@users.noreply.github.com> Co-authored-by: Oleg A. <t0rr@mail.ru> Co-authored-by: Josh Gross <joshmgross@github.com> Co-authored-by: r4mimu <52129983+fchimpan@users.noreply.github.com> Co-authored-by: Soubhik Kumar Mitra <59209034+x612skm@users.noreply.github.com> Co-authored-by: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Co-authored-by: Joel Ambass <Jcambass@users.noreply.github.com> Co-authored-by: mackey0225 <masaki.asano0225@gmail.com> Co-authored-by: Eman Resu <78693624+quatquatt@users.noreply.github.com> Co-authored-by: Jan T. Sott <git@idleberg.com> Co-authored-by: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: janco-absa <janco.bester@absa.africa> Co-authored-by: Tobbe Lundberg <tobbe@tlundberg.com> Co-authored-by: Alessandro Sebastiani <sebbalex@users.noreply.github.com> Co-authored-by: Rob Herley <robherley@github.com> Co-authored-by: Salman Chishti <salmanmkc@GitHub.com> Co-authored-by: Ben De St Paer-Gotch <nebuk89@github.com>
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