mirror of
https://github.com/actions/cache.git
synced 2024-11-21 17:31:27 +01:00
57b8e405f0
* 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
38 lines
1.6 KiB
YAML
38 lines
1.6 KiB
YAML
name: 'Restore Cache'
|
|
description: 'Restore Cache artifacts like dependencies and build outputs to improve workflow execution time'
|
|
author: 'GitHub'
|
|
inputs:
|
|
path:
|
|
description: 'A list of files, directories, and wildcard patterns to restore'
|
|
required: true
|
|
key:
|
|
description: 'An explicit key for restoring the cache'
|
|
required: true
|
|
restore-keys:
|
|
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.'
|
|
required: false
|
|
enableCrossOsArchive:
|
|
description: 'An optional boolean when enabled, allows windows runners to restore caches that were saved on other platforms'
|
|
default: 'false'
|
|
required: false
|
|
fail-on-cache-miss:
|
|
description: 'Fail the workflow if cache entry is not found'
|
|
default: 'false'
|
|
required: false
|
|
lookup-only:
|
|
description: 'Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache'
|
|
default: 'false'
|
|
required: false
|
|
outputs:
|
|
cache-hit:
|
|
description: 'A boolean value to indicate an exact match was found for the primary key'
|
|
cache-primary-key:
|
|
description: 'A resolved cache key for which cache match was attempted'
|
|
cache-matched-key:
|
|
description: 'Key of the cache that was restored, it could either be the primary key on cache-hit or a partial/complete match of one of the restore keys'
|
|
runs:
|
|
using: 'node20'
|
|
main: '../dist/restore-only/index.js'
|
|
branding:
|
|
icon: 'archive'
|
|
color: 'gray-dark'
|