2022-12-21 22:08:44 +08:00
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 list of keys to use for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.'
required : false
2023-01-05 19:19:13 +08:00
enableCrossOsArchive :
description : 'An optional boolean when enabled, allows windows runners to restore caches that were saved on other platforms'
default : 'false'
required : false
2023-01-30 19:10:58 +08:00
fail-on-cache-miss :
description : 'Fail the workflow if cache entry is not found'
default : 'false'
required : false
2023-03-09 20:30:28 +08:00
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
2022-12-21 22:08:44 +08:00
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 : 'node16'
main : '../dist/restore-only/index.js'
branding :
icon : 'archive'
2023-01-30 19:10:58 +08:00
color : 'gray-dark'
