mirror of
https://github.com/actions/cache.git
synced 2026-06-06 09:04:21 +00:00
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 <sakethpanuganti@gmail.com>
This commit is contained in:
parent
27d5ce7f10
commit
085b8e14fb
1 changed files with 2 additions and 1 deletions
|
|
@ -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'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue