mirror of
https://github.com/actions/cache.git
synced 2024-12-05 00:39:32 +01:00
c74ca4022c
The `save-always` input added in v4 is not working as intended due to `post-if` expressions not supporting the input context. To avoid breaking users who have already added this input to their workflows, it is being deprecated now and will be removed in the next major version (v5). See https://github.com/actions/cache/issues/1315 for more details.
47 lines
1.9 KiB
YAML
47 lines
1.9 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 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.'
|
|
required: false
|
|
upload-chunk-size:
|
|
description: 'The chunk size used to split up large files during upload, in bytes'
|
|
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
|
|
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.
|
|
outputs:
|
|
cache-hit:
|
|
description: 'A boolean value to indicate an exact match was found for the primary key'
|
|
runs:
|
|
using: 'node20'
|
|
main: 'dist/restore/index.js'
|
|
post: 'dist/save/index.js'
|
|
post-if: "success()"
|
|
branding:
|
|
icon: 'archive'
|
|
color: 'gray-dark'
|