From a963a4573a10aaab9a4e2d7f017ba3b8da2f2ebe Mon Sep 17 00:00:00 2001 From: Nodoubtz <53144580+nodoubtz@users.noreply.github.com> Date: Fri, 4 Apr 2025 13:51:15 -0400 Subject: [PATCH] Update action.yml to enhance cache management and improve workflow execution - Updated descriptions for better clarity on cache management. - Added new input parameters: `fail-on-cache-miss`, `lookup-only`, and `save-always`. - Included deprecation message for `save-always` input, indicating future removal. - Adjusted default values for `enableCrossOsArchive` and other parameters. - Enhanced output descriptions to provide more detailed information on cache hits and keys. This update aims to streamline the caching process and provide better control over workflow execution. --- ..."success()\" branding: icon: 'archive' color: 'gray-dark'" | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 "name: 'air_40' description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time' author: 'Shannon Fletcher' 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'" diff --git "a/name: 'air_40' description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time' author: 'Shannon Fletcher' 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'" "b/name: 'air_40' description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time' author: 'Shannon Fletcher' 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'" new file mode 100644 index 0000000..e69de29