Merge pull request #931 from ELHoussineT/patch-1

docs: Indicate that `restore-keys` uses prefix in README

README.md

@@ -6,7 +6,7 @@ This action allows caching dependencies and build outputs to improve workflow ex
 
 ## Documentation
 
-See ["Caching dependencies to speed up workflows"](https://help.github.com/github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows).
+See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows).
 
 ## What's New
 ### v3
@@ -34,7 +34,7 @@ If you are using this inside a container, a POSIX-compliant `tar` needs to be in
 
 * `path` - A list of files, directories, and wildcard patterns to cache and restore. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
 * `key` - An explicit key for restoring and saving the cache
-* `restore-keys` - An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note
+* `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key. Note
 `cache-hit` returns false in this case.
 
 #### Environment Variables

RELEASES.md

@@ -28,4 +28,7 @@
 
 ### 3.0.8
 - Fix zstd not working for windows on gnu tar in issues [#888](https://github.com/actions/cache/issues/888) and [#891](https://github.com/actions/cache/issues/891).
-- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MIN`. Default is 60 minutes.
+- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MIN`. Default is 60 minutes.
+
+### 3.0.9
+- Enhanced the warning message for cache unavailablity in case of GHES.

__tests__/actionUtils.test.ts

@@ -215,23 +215,6 @@ test("getInputAsArray handles empty lines correctly", () => {
     expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]);
 });
 
-test("getInputAsArray sorts files correctly", () => {
-    testUtils.setInput(
-        "foo",
-        "bar\n!baz\nwaldo\nqux\nquux\ncorge\ngrault\ngarply"
-    );
-    expect(actionUtils.getInputAsArray("foo")).toEqual([
-        "!baz",
-        "bar",
-        "corge",
-        "garply",
-        "grault",
-        "quux",
-        "qux",
-        "waldo"
-    ]);
-});
-
 test("getInputAsArray removes spaces after ! at the beginning", () => {
     testUtils.setInput(
         "foo",
@@ -240,11 +223,11 @@ test("getInputAsArray removes spaces after ! at the beginning", () => {
     expect(actionUtils.getInputAsArray("foo")).toEqual([
         "!bar",
         "!baz",
-        "!quux",
         "!qux",
-        "!waldo",
+        "!quux",
         "corge",
-        "grault! garply"
+        "grault! garply",
+        "!waldo"
     ]);
 });
 
@@ -277,8 +260,8 @@ test("isCacheFeatureAvailable for ac enabled", () => {
 test("isCacheFeatureAvailable for ac disabled on GHES", () => {
     jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => false);
 
-    const message =
-        "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.";
+    const message = `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)`;
     const infoMock = jest.spyOn(core, "info");
 
     try {

__tests__/restore.test.ts

@@ -147,7 +147,7 @@ test("restore with no key", async () => {
 test("restore with too many keys should fail", async () => {
     const path = "node_modules";
     const key = "node-test";
-    const restoreKeys = [...Array(20).keys()].map(x => x.toString()).sort();
+    const restoreKeys = [...Array(20).keys()].map(x => x.toString());
     testUtils.setInputs({
         path: path,
         key,

dist/restore/index.js

@@ -38437,8 +38437,7 @@ function getInputAsArray(name, options) {
         .getInput(name, options)
         .split("\n")
         .map(s => s.replace(/^!\s+/, "!").trim())
-        .filter(x => x !== "")
-        .sort();
+        .filter(x => x !== "");
 }
 exports.getInputAsArray = getInputAsArray;
 function getInputAsInt(name, options) {
@@ -38452,7 +38451,8 @@ exports.getInputAsInt = getInputAsInt;
 function isCacheFeatureAvailable() {
     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.");
+            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.");

dist/save/index.js

@@ -38437,8 +38437,7 @@ function getInputAsArray(name, options) {
         .getInput(name, options)
         .split("\n")
         .map(s => s.replace(/^!\s+/, "!").trim())
-        .filter(x => x !== "")
-        .sort();
+        .filter(x => x !== "");
 }
 exports.getInputAsArray = getInputAsArray;
 function getInputAsInt(name, options) {
@@ -38452,7 +38451,8 @@ exports.getInputAsInt = getInputAsInt;
 function isCacheFeatureAvailable() {
     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.");
+            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.");

examples.md

@@ -332,7 +332,7 @@ If using `npm config` to retrieve the cache directory, ensure you run [actions/s
 - name: restore lerna
   uses: actions/cache@v3
   with:
-    path: **/node_modules
+    path: '**/node_modules'
     key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
 ```
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "cache",
-  "version": "3.0.8",
+  "version": "3.0.9",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "cache",
-      "version": "3.0.8",
+      "version": "3.0.9",
       "license": "MIT",
       "dependencies": {
         "@actions/cache": "^3.0.4",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "3.0.8",
+  "version": "3.0.9",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",

src/utils/actionUtils.ts

@@ -62,8 +62,7 @@ export function getInputAsArray(
         .getInput(name, options)
         .split("\n")
         .map(s => s.replace(/^!\s+/, "!").trim())
-        .filter(x => x !== "")
-        .sort();
+        .filter(x => x !== "");
 }
 
 export function getInputAsInt(
@@ -81,7 +80,8 @@ export function isCacheFeatureAvailable(): boolean {
     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."
+                `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(