Updated node example

.github/workflows/check-dist.yml

@@ -27,7 +27,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
-          cache: npm
       - name: Install dependencies
         run: npm ci
       - name: Rebuild the dist/ directory

.github/workflows/workflow.yml

@@ -25,7 +25,17 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: 16.x
-        cache: npm
+    - name: Determine npm cache directory
+      id: npm-cache
+      run: |
+        echo "::set-output name=dir::$(npm config get cache)"
+    - name: Restore npm cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.npm-cache.outputs.dir }}
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
     - run: npm ci
     - name: Prettier Format Check
       run: npm run format-check

RELEASES.md

@@ -40,12 +40,3 @@
 ### 3.0.11
 - Update toolkit version to 3.0.5 to include `@actions/core@^1.10.0`
 - Update `@actions/cache` to use updated `saveState` and `setOutput` functions from `@actions/core@^1.10.0`
-
-### 3.1.0-beta.1
-- Update `@actions/cache` on windows to use gnu tar and zstd by default and fallback to bsdtar and zstd if gnu tar is not available. ([issue](https://github.com/actions/cache/issues/984))
-
-### 3.1.0-beta.2
-- Added support for fallback to gzip to restore old caches on windows.
-
-### 3.1.0-beta.3
-- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows.

examples.md

@@ -313,11 +313,26 @@ After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-depr
 
 >Note: It is not recommended to cache `node_modules`, as it can break across Node versions and won't work with `npm ci`
 
+### **Get npm cache directory using default shells**
+### Linux or Mac
+```yaml
+- name: Get npm cache directory
+  id: npm-cache
+  run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
+```
+
+### Windows
+```yaml
+- name: Get npm cache directory
+  id: npm-cache
+  run: echo "dir=$(npm config get cache)" >> ${env:GITHUB_OUTPUT}
+```
+
 ### **Get npm cache directory using same shell**
 ### Bash shell
 ```yaml
 - name: Get npm cache directory
-  id: npm-cache-dir
+  id: npm-cache
   shell: bash
   run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
 ```
@@ -325,7 +340,7 @@ After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-depr
 ### PWSH shell
 ```yaml
 - name: Get npm cache directory
-  id: npm-cache-dir
+  id: npm-cache
   shell: pwsh
   run: echo "dir=$(npm config get cache)" >> ${env:GITHUB_OUTPUT}
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "3.1.0-beta.3",
+  "version": "3.0.11",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
@@ -23,29 +23,29 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "3.1.0-beta.3",
+    "@actions/cache": "^3.0.5",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
     "@actions/io": "^1.1.2"
   },
   "devDependencies": {
-    "@types/jest": "^27.5.2",
+    "@types/jest": "^27.5.0",
     "@types/nock": "^11.1.0",
-    "@types/node": "^16.18.3",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
+    "@types/node": "^16.11.33",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
     "@zeit/ncc": "^0.20.5",
-    "eslint": "^8.28.0",
+    "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^26.9.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-jest": "^26.1.5",
+    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
-    "jest": "^28.1.3",
+    "jest": "^28.0.3",
     "jest-circus": "^27.5.1",
-    "nock": "^13.2.9",
-    "prettier": "^2.8.0",
-    "ts-jest": "^28.0.8",
-    "typescript": "^4.9.3"
+    "nock": "^13.2.4",
+    "prettier": "^2.6.2",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.6.4"
   }
 }

src/utils/actionUtils.ts

@@ -77,20 +77,19 @@ export function getInputAsInt(
 }
 
 export function isCacheFeatureAvailable(): boolean {
-    if (cache.isFeatureAvailable()) {
-        return true;
-    }
-
-    if (isGhes()) {
-        logWarning(
-            `Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.
+    if (!cache.isFeatureAvailable()) {
+        if (isGhes()) {
+            logWarning(
+                `Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.
 Otherwise please upgrade to GHES version >= 3.5 and If you are also using Github Connect, please unretire the actions/cache namespace before upgrade (see https://docs.github.com/en/enterprise-server@3.5/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)`
-        );
+            );
+        } else {
+            logWarning(
+                "An internal error has occurred in cache backend. Please check https://www.githubstatus.com/ for any ongoing issue in actions."
+            );
+        }
         return false;
     }
 
-    logWarning(
-        "An internal error has occurred in cache backend. Please check https://www.githubstatus.com/ for any ongoing issue in actions."
-    );
-    return false;
+    return true;
 }

tips-and-workarounds.md

@@ -14,7 +14,7 @@ A cache today is immutable and cannot be updated. But some use cases require the
           restore-keys: |
             primes-${{ runner.os }}
   ```          
-  Please note that this will create a new cache on every run and hence will consume the cache [quota](./README.md#cache-limits).
+  Please note that this will create a new cache on every run and hence will consume the cache [quota](#cache-limits).
   
 ## Use cache across feature branches
 Reusing cache across feature branches is not allowed today to provide cache [isolation](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache). However if both feature branches are from the default branch, a good way to achieve this is to ensure that the default branch has a cache. This cache will then be consumable by both feature branches.