Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a bit of detail to tool-cache README.md #358

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/tool-cache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down