From 8afb976445ccec5c959d57cec73a9caa5c69337b Mon Sep 17 00:00:00 2001 From: Vikas Kedia Date: Mon, 12 Apr 2021 07:18:07 -0700 Subject: [PATCH] Update README.md (#531) more logical to read save cache before restore cache --- packages/cache/README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 2d5aa1a9..1fa1eead 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -10,6 +10,20 @@ Note that GitHub will remove any cache entries that have not been accessed in ov 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). +#### Save Cache + +Saves a cache containing the files in `paths` using the `key` provided. The files would be compressed using zstandard compression algorithm if zstd is installed, otherwise gzip is used. Function returns the cache id if the cache was saved succesfully and throws an error if cache upload fails. + +```js +const cache = require('@actions/cache'); +const paths = [ + 'node_modules', + 'packages/*/node_modules/' +] +const key = 'npm-foobar-d5ea0750' +const cacheId = await cache.saveCache(paths, key) +``` + #### 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. @@ -28,17 +42,3 @@ const restoreKeys = [ const cacheKey = await cache.restoreCache(paths, key, restoreKeys) ``` -#### Save Cache - -Saves a cache containing the files in `paths` using the `key` provided. The files would be compressed using zstandard compression algorithm if zstd is installed, otherwise gzip is used. Function returns the cache id if the cache was saved succesfully and throws an error if cache upload fails. - -```js -const cache = require('@actions/cache'); -const paths = [ - 'node_modules', - 'packages/*/node_modules/' -] -const key = 'npm-foobar-d5ea0750' -const cacheId = await cache.saveCache(paths, key) -``` -