From bed79ee8092a7e0f87e62671a75f7cc139c1e4fd Mon Sep 17 00:00:00 2001 From: Joshua Hale Date: Wed, 19 Feb 2020 11:56:31 +0000 Subject: [PATCH] update tool-cache README.md --- packages/tool-cache/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/tool-cache/README.md b/packages/tool-cache/README.md index a1513d3529..74ba31bc98 100644 --- a/packages/tool-cache/README.md +++ b/packages/tool-cache/README.md @@ -2,6 +2,11 @@ > Functions necessary for downloading and caching tools. +The tool-cache caches downloads in the environment in which an action runs. + +For hosted runners, the lifetime of the cache is therefore limited to the Job because the Job defines the lifetime of the VM in which the action that exploits the cache runs. +This does not mean that the tool-cache is redundant for downloads that occur only once in a Job, because many popular tools are pre-populated in the tool-cache for hosted runners. + ## Usage #### Download