2020-02-05 10:39:52 -05:00
|
|
|
name: 'Cache'
|
2020-01-14 15:11:41 +00:00
|
|
|
description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time'
|
2019-10-30 14:48:49 -04:00
|
|
|
author: 'GitHub'
|
|
|
|
inputs:
|
|
|
|
path:
|
2020-05-26 14:58:07 -04:00
|
|
|
description: 'A list of files, directories, and wildcard patterns to cache and restore'
|
2019-10-30 14:48:49 -04:00
|
|
|
required: true
|
|
|
|
key:
|
|
|
|
description: 'An explicit key for restoring and saving the cache'
|
|
|
|
required: true
|
|
|
|
restore-keys:
|
|
|
|
description: 'An ordered list of keys to use for restoring the cache if no cache hit occurred for key'
|
|
|
|
required: false
|
2020-10-02 11:01:24 -05:00
|
|
|
upload-chunk-size:
|
2020-10-02 11:22:20 -05:00
|
|
|
description: 'The chunk size used to split up large files during upload, in bytes'
|
2020-10-02 11:01:24 -05:00
|
|
|
required: false
|
2021-04-21 21:33:20 -06:00
|
|
|
skip-save:
|
2021-05-09 17:33:34 -06:00
|
|
|
description: >-
|
|
|
|
Whether or not to skip the saving of the cache. If this is set
|
|
|
|
to "true", the cache will not be saved. It can also be set to
|
|
|
|
an environment variable such as "\$\{\{ env.MY_SKIP_SAVE \}\}".
|
|
|
|
If the MY_SKIP_SAVE environment variable is "true" by the end of
|
|
|
|
the CI, caching will be skipped. Default is to update if and
|
|
|
|
only if there was no primary-key exact cache hit.
|
2021-04-21 21:33:20 -06:00
|
|
|
required: false
|
|
|
|
default: false
|
2019-10-30 14:48:49 -04:00
|
|
|
outputs:
|
|
|
|
cache-hit:
|
|
|
|
description: 'A boolean value to indicate an exact match was found for the primary key'
|
|
|
|
runs:
|
|
|
|
using: 'node12'
|
|
|
|
main: 'dist/restore/index.js'
|
|
|
|
post: 'dist/save/index.js'
|
|
|
|
post-if: 'success()'
|
|
|
|
branding:
|
|
|
|
icon: 'archive'
|
2020-01-14 15:11:41 +00:00
|
|
|
color: 'gray-dark'
|