From 085b8e14fba5283bd18fd966a74968eceaaba287 Mon Sep 17 00:00:00 2001 From: Kranthi Poturaju Date: Fri, 8 May 2026 18:36:59 +0530 Subject: [PATCH] docs(action): add missing input defaults and fix cache-hit description - Add to and inputs, making the absence-of-value behaviour explicit and consistent with all other optional inputs in the file. - Expand the output description to document all three observable states: 'true' on exact key match, 'false' on partial restore-key match or unavailable cache service, and not set when no cache entry is found (intentional; see actions/cache#1466). Co-authored-by: Kranthi Poturaju <152148+kranthipoturaju@users.noreply.github.com> Co-authored-by: Panuganti Saketh --- action.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 2606455..6302b5c 100644 --- a/action.yml +++ b/action.yml @@ -11,6 +11,7 @@ inputs: 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 + default: '' upload-chunk-size: description: 'The chunk size used to split up large files during upload, in bytes' required: false @@ -36,7 +37,7 @@ inputs: 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' + description: "A boolean value to indicate an exact match was found for the primary key. Returns 'true' on exact key match, 'false' on partial match via restore-keys or when the cache service is unavailable. Not set when no cache entry is found." runs: using: 'node24' main: 'dist/restore/index.js'