Merge branch 'main' into fix-cache-hit-output

2024-12-27 21:15:54 +00:00 · 2022-08-25 14:26:47 +05:30 · 2022-08-25 14:26:47 +05:30 · 883f85e649
commit 883f85e649
parent 7f5799b6ac 6c9470d12d
15 changed files with 4124 additions and 3894 deletions
--- a/.github/auto_assign.yml
+++ b/.github/auto_assign.yml
@ -6,6 +6,9 @@ addAssignees: false

 # A list of reviewers to be added to pull requests (GitHub user name)
 reviewers:
+  - pallavx
+  - pdotl
+  - phantsure
  - kotewar
  - aparna-ravindra
  - tiwarishub
--- a/.github/workflows/auto-assign-issues.yml
+++ b/.github/workflows/auto-assign-issues.yml
@ -11,5 +11,5 @@ jobs:
            - name: 'Auto-assign issue'
              uses: pozil/auto-assign-issue@v1.4.0
              with:
-                  assignees: kotewar,tiwarishub,aparna-ravindra,vsvipul,bishal-pdmsft
+                  assignees: pallavx,pdotl,phantsure,kotewar,tiwarishub,aparna-ravindra,vsvipul,bishal-pdmsft
                  numOfAssignee: 1
--- a/.licenses/npm/@actions/cache.dep.yml
+++ b/.licenses/npm/@actions/cache.dep.yml
--- a/.licenses/npm/@actions/core.dep.yml
+++ b/.licenses/npm/@actions/core.dep.yml
--- a/.licenses/npm/@actions/http-client.dep.yml
+++ b/.licenses/npm/@actions/http-client.dep.yml
--- a/README.md
+++ b/README.md
@ -15,6 +15,11 @@ See ["Caching dependencies to speed up workflows"](https://help.github.com/githu
 * Updated the minimum runner version support from node 12 -> node 16.
 * Fixed avoiding empty cache save when no files are available for caching.
 * Fixed tar creation error while trying to create tar with path as `~/` home folder on `ubuntu-latest`.
+* Fixed zstd failing on amazon linux 2.0 runners.
+* Fixed cache not working with github workspace directory or current directory.
+* Fixed the download stuck problem by introducing a timeout of 1 hour for cache downloads.
+* Fix zstd not working for windows on gnu tar in issues.
+* 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.

 Refer [here](https://github.com/actions/cache/blob/v2/README.md) for previous versions

@ -32,6 +37,9 @@ If you are using this inside a container, a POSIX-compliant `tar` needs to be in
 * `restore-keys` - An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. Note
 `cache-hit` returns false in this case.

+#### Environment Variables
+* `SEGMENT_DOWNLOAD_TIMEOUT_MIN` - Segment download timeout (in minutes, default `60`) to abort download of the segment if not completed in the defined number of minutes. [Read more](#cache-segment-restore-timeout)
+
 ### Outputs

 * `cache-hit` - A boolean value to indicate an exact match was found for the key
@ -81,6 +89,7 @@ Every programming language and framework has its own way of caching.
 See [Examples](examples.md) for a list of `actions/cache` implementations for use with:

 - [C# - NuGet](./examples.md#c---nuget)
+- [Clojure - Lein Deps](./examples.md#clojure---lein-deps)
 - [D - DUB](./examples.md#d---dub)
 - [Deno](./examples.md#deno)
 - [Elixir - Mix](./examples.md#elixir---mix)
@ -214,6 +223,30 @@ jobs:
        if: steps.cache-primes.outputs.cache-hit != 'true'
        run: ./generate-primes -d prime-numbers
 ```
+## Cache segment restore timeout
+
+A cache gets downloaded in multiple segments of fixed sizes (`1GB` for a `32-bit` runner and `2GB` for a `64-bit` runner). Sometimes, a segment download gets stuck which causes the workflow job to be stuck forever and fail. Version `v3.0.8` of `actions/cache` introduces a segment download timeout. The segment download timeout will allow the segment download to get aborted and hence allow the job to proceed with a cache miss.
+
+Default value of this timeout is 60 minutes and can be customized by specifying an [environment variable](https://docs.github.com/en/actions/learn-github-actions/environment-variables) named `SEGMENT_DOWNLOAD_TIMEOUT_MINS` with timeout value in minutes.
+
+## Known practices and workarounds
+Following are some of the known practices/workarounds which community has used to fulfill specific requirements. You may choose to use them if suits your use case. Note these are not necessarily the only or the recommended solution.
+
+#### Update a cache
+A cache today is immutable and cannot be updated. But some use cases require the cache to be saved even though there was a "hit" during restore. To do so, use a `key` which is unique for every run and use `restore-keys` to restore the nearest cache. For example:
+  ```
+      - name: update cache on every commit
+        uses: actions/cache@v3
+        with:
+          path: prime-numbers
+          key: primes-${{ runner.os }}-${{ github.run_id }} # Can use time based key as well
+          restore-keys: |
+            primes-${{ runner.os }}
+  ```          
+  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.

 ## Contributing
 We would love for you to contribute to `actions/cache`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
--- a/RELEASES.md
+++ b/RELEASES.md
@ -17,4 +17,15 @@
 - Fixed tar creation error while trying to create tar with path as `~/` home folder on `ubuntu-latest`. ([issue](https://github.com/actions/cache/issues/689))

 ### 3.0.5
- Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit. ([PR](https://github.com/actions/cache/pull/834))
+- Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit. ([PR](https://github.com/actions/cache/pull/834))
+
+### 3.0.6
+- Fixed [#809](https://github.com/actions/cache/issues/809) - zstd -d: no such file or directory error
+- Fixed [#833](https://github.com/actions/cache/issues/833) - cache doesn't work with github workspace directory
+
+### 3.0.7
+- Fixed [#810](https://github.com/actions/cache/issues/810) - download stuck issue. A new timeout is introduced in the download process to abort the download if it gets stuck and doesn't finish within an hour.
+
+### 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.
--- a/tests/actionUtils.test.ts
+++ b/tests/actionUtils.test.ts
@ -215,6 +215,39 @@ 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",
+        "!   bar\n!  baz\n! qux\n!quux\ncorge\ngrault! garply\n!\r\t waldo"
+    );
+    expect(actionUtils.getInputAsArray("foo")).toEqual([
+        "!bar",
+        "!baz",
+        "!quux",
+        "!qux",
+        "!waldo",
+        "corge",
+        "grault! garply"
+    ]);
+});
+
 test("getInputAsInt returns undefined if input not set", () => {
    expect(actionUtils.getInputAsInt("undefined")).toBeUndefined();
 });
--- a/tests/restore.test.ts
+++ b/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());
+    const restoreKeys = [...Array(20).keys()].map(x => x.toString()).sort();
    testUtils.setInputs({
        path: path,
        key,
--- a/dist/restore/index.js
+++ b/dist/restore/index.js
--- a/dist/save/index.js
+++ b/dist/save/index.js
--- a/examples.md
+++ b/examples.md
@ -1,6 +1,7 @@
 # Examples

 - [C# - NuGet](#c---nuget)
+- [Clojure - Lein Deps](#clojure---lein-deps)
 - [D - DUB](#d---dub)
  - [POSIX](#posix)
  - [Windows](#windows)
@ -80,6 +81,19 @@ steps:
        ${{ runner.os }}-nuget-
 ```

+## Clojure - Lein Deps
+
+```yaml
+- name: Cache lein project dependencies
+  uses: actions/cache@v3
+  with:
+    path: ~/.m2/repository
+    key: ${{ runner.os }}-clojure-${{ hashFiles('**/project.clj') }}
+    restore-keys: |
+      ${{ runner.os }}-clojure
+```
+
+
 ## D - DUB

 ### POSIX
--- a/package-lock.json
+++ b/package-lock.json
@ -1,16 +1,16 @@
 {
  "name": "cache",
-  "version": "3.0.5",
+  "version": "3.0.8",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "cache",
-      "version": "3.0.5",
+      "version": "3.0.8",
      "license": "MIT",
      "dependencies": {
-        "@actions/cache": "^3.0.0",
-        "@actions/core": "^1.7.0",
+        "@actions/cache": "^3.0.4",
+        "@actions/core": "^1.9.1",
        "@actions/exec": "^1.1.1",
        "@actions/io": "^1.1.2"
      },
@ -36,9 +36,9 @@
      }
    },
    "node_modules/@actions/cache": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.0.0.tgz",
-      "integrity": "sha512-GL9CT1Fnu+pqs8TTB621q8Xa8Cilw2n9MwvbgMedetH7L1q2n6jY61gzbwGbKgtVbp3gVJ12aNMi4osSGXx3KQ==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.0.4.tgz",
+      "integrity": "sha512-9RwVL8/ISJoYWFNH1wR/C26E+M3HDkGPWmbFJMMCKwTkjbNZJreMT4XaR/EB1bheIvN4PREQxEQQVJ18IPnf/Q==",
      "dependencies": {
        "@actions/core": "^1.2.6",
        "@actions/exec": "^1.0.1",
@ -51,20 +51,21 @@
        "uuid": "^3.3.3"
      }
    },
-    "node_modules/@actions/cache/node_modules/@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
+    "node_modules/@actions/core": {
+      "version": "1.9.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
      "dependencies": {
-        "tunnel": "^0.0.6"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
      }
    },
-    "node_modules/@actions/core": {
-      "version": "1.7.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.7.0.tgz",
-      "integrity": "sha512-7fPSS7yKOhTpgLMbw7lBLc1QJWvJBBAgyTX2PEhagWcKK8t0H8AKCoPMfnrHqIm5cRYH4QFPqD1/ruhuUE7YcQ==",
-      "dependencies": {
-        "@actions/http-client": "^1.0.11"
+    "node_modules/@actions/core/node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
      }
    },
    "node_modules/@actions/exec": {
@ -85,11 +86,11 @@
      }
    },
    "node_modules/@actions/http-client": {
-      "version": "1.0.11",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
+      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
      "dependencies": {
-        "tunnel": "0.0.6"
+        "tunnel": "^0.0.6"
      }
    },
    "node_modules/@actions/io": {
@ -9533,9 +9534,9 @@
  },
  "dependencies": {
    "@actions/cache": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.0.0.tgz",
-      "integrity": "sha512-GL9CT1Fnu+pqs8TTB621q8Xa8Cilw2n9MwvbgMedetH7L1q2n6jY61gzbwGbKgtVbp3gVJ12aNMi4osSGXx3KQ==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/@actions/cache/-/cache-3.0.4.tgz",
+      "integrity": "sha512-9RwVL8/ISJoYWFNH1wR/C26E+M3HDkGPWmbFJMMCKwTkjbNZJreMT4XaR/EB1bheIvN4PREQxEQQVJ18IPnf/Q==",
      "requires": {
        "@actions/core": "^1.2.6",
        "@actions/exec": "^1.0.1",
@ -9546,24 +9547,22 @@
        "@azure/storage-blob": "^12.8.0",
        "semver": "^6.1.0",
        "uuid": "^3.3.3"
-      },
-      "dependencies": {
-        "@actions/http-client": {
-          "version": "2.0.1",
-          "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-          "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
-          "requires": {
-            "tunnel": "^0.0.6"
-          }
-        }
      }
    },
    "@actions/core": {
-      "version": "1.7.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.7.0.tgz",
-      "integrity": "sha512-7fPSS7yKOhTpgLMbw7lBLc1QJWvJBBAgyTX2PEhagWcKK8t0H8AKCoPMfnrHqIm5cRYH4QFPqD1/ruhuUE7YcQ==",
+      "version": "1.9.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
      "requires": {
-        "@actions/http-client": "^1.0.11"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
+      },
+      "dependencies": {
+        "uuid": {
+          "version": "8.3.2",
+          "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+          "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
+        }
      }
    },
    "@actions/exec": {
@ -9584,11 +9583,11 @@
      }
    },
    "@actions/http-client": {
-      "version": "1.0.11",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
-      "integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
+      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
      "requires": {
-        "tunnel": "0.0.6"
+        "tunnel": "^0.0.6"
      }
    },
    "@actions/io": {
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "cache",
-  "version": "3.0.5",
+  "version": "3.0.8",
  "private": true,
  "description": "Cache dependencies and build outputs",
  "main": "dist/restore/index.js",
@ -23,8 +23,8 @@
  "author": "GitHub",
  "license": "MIT",
  "dependencies": {
-    "@actions/cache": "^3.0.0",
-    "@actions/core": "^1.7.0",
+    "@actions/cache": "^3.0.4",
+    "@actions/core": "^1.9.1",
    "@actions/exec": "^1.1.1",
    "@actions/io": "^1.1.2"
  },
@ -48,4 +48,4 @@
    "ts-jest": "^28.0.2",
    "typescript": "^4.6.4"
  }
-}
+}
--- a/src/utils/actionUtils.ts
+++ b/src/utils/actionUtils.ts
@ -61,8 +61,9 @@ export function getInputAsArray(
    return core
        .getInput(name, options)
        .split("\n")
-        .map(s => s.trim())
-        .filter(x => x !== "");
+        .map(s => s.replace(/^!\s+/, "!").trim())
+        .filter(x => x !== "")
+        .sort();
 }

 export function getInputAsInt(