actions/toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update cache readme to include a link to cache action (#478)

Browse Source 
Co-authored-by: Aiqiao Yan <[email protected]>
This commit is contained in:
Aiqiao Yan
2020-06-19 14:43:10 -04:00
committed by GitHub
co-authored by Aiqiao Yan
parent 8e14ff9f0a
commit 66931ff481
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cache/README.md
Vendored
+3
View File
@@ -8,6 +8,8 @@ Note that GitHub will remove any cache entries that have not been accessed in ov
## Usage ## 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 #### 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. 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.
@@ -39,3 +41,4 @@ const paths = [
const key = 'npm-foobar-d5ea0750' const key = 'npm-foobar-d5ea0750'
const cacheId = await cache.saveCache(paths, key) const cacheId = await cache.saveCache(paths, key)
``` ```