mirror of
https://github.com/actions/cache.git
synced 2025-03-13 11:47:00 +00:00
ffdb03bc68
The skip-save option allows users to force the cache to skip saving the cache. skip-save can be set to a constant or to an expression that will be evaluated at the end of the CI job, such as an environment variable. This is for #498
31 lines
1.3 KiB
YAML
31 lines
1.3 KiB
YAML
name: 'Cache'
|
|
description: '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 cache and restore'
|
|
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
|
|
upload-chunk-size:
|
|
description: 'The chunk size used to split up large files during upload, in bytes'
|
|
required: false
|
|
skip-save:
|
|
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 evironment 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.'
|
|
required: false
|
|
default: false
|
|
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'
|
|
color: 'gray-dark'
|