cache/action.yml

36 lines
1.3 KiB
YAML
Raw Normal View History

2020-02-05 15:39:52 +00:00
name: 'Cache'
description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time'
2019-10-30 18:48:49 +00:00
author: 'GitHub'
inputs:
path:
2020-05-26 19:58:07 +01:00
description: 'A list of files, directories, and wildcard patterns to cache and restore'
2019-10-30 18:48:49 +00:00
required: true
key:
description: 'An explicit key for restoring and saving the cache'
required: true
restore-keys:
2021-03-25 23:36:55 +00: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-30 18:48:49 +00:00
required: false
2020-10-02 17:01:24 +01:00
upload-chunk-size:
2020-10-02 17:22:20 +01:00
description: 'The chunk size used to split up large files during upload, in bytes'
2020-10-02 17:01:24 +01:00
required: false
2022-11-25 09:16:56 +00:00
exit-on-cache-miss:
description: 'Fail the workflow if the cache is not found for the primary key'
required: false
default: false
save-on-any-failure:
description: 'Save cache (on cache miss) despite of any failure during the workflow run'
required: false
default: false
2019-10-30 18:48:49 +00:00
outputs:
cache-hit:
description: 'A boolean value to indicate an exact match was found for the primary key'
runs:
using: 'node16'
2019-10-30 18:48:49 +00:00
main: 'dist/restore/index.js'
post: 'dist/save/index.js'
2022-11-25 09:16:56 +00:00
post-if: (success() || (env.SAVE_CACHE_ON_ANY_FAILURE == 'yes'))
2019-10-30 18:48:49 +00:00
branding:
icon: 'archive'
color: 'gray-dark'