cache/action.yml

48 lines
1.9 KiB
YAML
Raw Permalink Normal View History

2020-02-05 10:39:52 -05:00
name: 'Cache'
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 multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case.'
2019-10-30 14:48:49 -04:00
required: false
2020-10-02 12:01:24 -04:00
upload-chunk-size:
2020-10-02 12:22:20 -04:00
description: 'The chunk size used to split up large files during upload, in bytes'
2020-10-02 12:01:24 -04:00
required: false
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
fail-on-cache-miss:
description: 'Fail the workflow if cache entry is not found'
default: 'false'
required: false
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
2023-09-13 07:58:52 -04:00
save-always:
description: 'Run the post step to save the cache even if another step before fails'
default: 'false'
required: false
deprecationMessage: |
save-always does not work as intended and will be removed in a future release.
A separate `actions/cache/restore` step should be used instead.
See https://github.com/actions/cache/tree/main/save#always-save-cache for more details.
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:
2023-11-20 08:30:40 -05:00
using: 'node20'
2019-10-30 14:48:49 -04:00
main: 'dist/restore/index.js'
post: 'dist/save/index.js'
post-if: "success()"
2019-10-30 14:48:49 -04:00
branding:
icon: 'archive'
color: 'gray-dark'