mirror of
https://github.com/actions/cache.git
synced 2026-06-06 09:04:21 +00:00
55 lines
2.4 KiB
YAML
55 lines
2.4 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
|
|
strict-paths:
|
|
description: |
|
|
Controls client-side validation of cache archive entry paths before extraction.
|
|
'off' disables validation (legacy behavior). 'warn' logs a single warning when any
|
|
entry would resolve outside the declared `path` inputs and still extracts the cache.
|
|
'error' rejects the cache with a CacheIntegrityError and skips extraction entirely.
|
|
Default is 'warn'.
|
|
default: 'warn'
|
|
required: false
|
|
fail-on-cache-invalid:
|
|
description: |
|
|
Fail the workflow if the restored cache is rejected by client-side path validation
|
|
(entries that escape the declared paths, or an archive that cannot be parsed).
|
|
Only applies when `strict-paths` is 'error'; the 'off' and 'warn' modes never
|
|
reject a cache. When 'false' (default), a rejected cache is treated as a cache miss.
|
|
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: 'node24'
|
|
main: '../dist/restore-only/index.js'
|
|
branding:
|
|
icon: 'archive'
|
|
color: 'gray-dark'
|