mirror of
https://git.mirrors.martin98.com/https://github.com/actions/toolkit
synced 2025-11-18 17:21:06 +08:00
Update cache readme to include a link to cache action (#478)
Co-authored-by: Aiqiao Yan <aiqiaoy@aiqiaos-mbp.attlocal.net>
This commit is contained in:
parent
8e14ff9f0a
commit
66931ff481
5
packages/cache/README.md
vendored
5
packages/cache/README.md
vendored
@ -8,6 +8,8 @@ Note that GitHub will remove any cache entries that have not been accessed in ov
|
||||
|
||||
## Usage
|
||||
|
||||
This package is used by the v2+ versions of our first party cache action. You can find an example implementation in the cache repo [here](https://github.com/actions/cache).
|
||||
|
||||
#### Restore Cache
|
||||
|
||||
Restores a cache based on `key` and `restoreKeys` to the `paths` provided. Function returns the cache key for cache hit and returns undefined if cache not found.
|
||||
@ -38,4 +40,5 @@ const paths = [
|
||||
]
|
||||
const key = 'npm-foobar-d5ea0750'
|
||||
const cacheId = await cache.saveCache(paths, key)
|
||||
```
|
||||
```
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user