2020-02-05 23:39:52 +08:00
name : 'Cache'
2020-01-14 23:11:41 +08:00
description : 'Cache artifacts like dependencies and build outputs to improve workflow execution time'
2019-10-31 02:48:49 +08:00
author : 'GitHub'
inputs :
path :
2020-05-27 02:58:07 +08:00
description : 'A list of files, directories, and wildcard patterns to cache and restore'
2019-10-31 02:48:49 +08:00
required : true
key :
description : 'An explicit key for restoring and saving the cache'
required : true
restore-keys :
2021-03-26 07:36:55 +08:00
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.'
2019-10-31 02:48:49 +08:00
required : false
2020-10-03 00:01:24 +08:00
upload-chunk-size :
2020-10-03 00:22:20 +08:00
description : 'The chunk size used to split up large files during upload, in bytes'
2020-10-03 00:01:24 +08:00
required : false
2023-01-05 19:19:13 +08:00
enableCrossOsArchive :
description : 'An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively 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
2019-10-31 02:48:49 +08:00
outputs :
cache-hit :
description : 'A boolean value to indicate an exact match was found for the primary key'
runs :
2023-09-05 12:18:13 +08:00
using : 'node20'
2019-10-31 02:48:49 +08:00
main : 'dist/restore/index.js'
post : 'dist/save/index.js'
2022-12-21 22:08:44 +08:00
post-if : success()
2019-10-31 02:48:49 +08:00
branding :
icon : 'archive'
2020-01-14 23:11:41 +08:00
color : 'gray-dark'
