Upload files to "/"

.licensed.yml

@@ -1,14 +1,6 @@
 sources:
   npm: true
 
-# Force UTF-8 encoding
-encoding: 'utf-8'
-
-# Ignore problematic packages with encoding issues
-ignored:
-  npm:
-    - form-data
-
 allowed:
   - apache-2.0
   - bsd-2-clause
@@ -28,4 +20,3 @@ reviewed:
   - glob # ISC
   - prettier # MIT
   - lodash # MIT
-  - "@actions/http-client" # MIT

CONTRIBUTING.md

@@ -16,7 +16,7 @@ Please note that this project is released with a [Contributor Code of Conduct][c
 1. [Fork][fork] and clone the repository
 2. Configure and install the dependencies: `npm install`
 3. Make sure the tests pass on your machine: `npm run test`
-4. Create a new branch: `git switch -c my-branch-name`
+4. Create a new branch: `git checkout -b my-branch-name`
 5. Make your change, add tests, and make sure the tests still pass
 6. Push to your fork and [submit a pull request][pr]
 7. Pat your self on the back and wait for your pull request to be reviewed and merged.

README.md

@@ -1,88 +1,338 @@
-# Save action
+# Cache action
 
-The save action saves a cache. It works similarly to the `cache` action except that it doesn't first do a restore. This action provides granular ability to save a cache without having to restore it, or to do a save at any stage of the workflow job -- not only in post phase.
+This action allows caching dependencies and build outputs to improve workflow execution time.
+
+>Two other actions are available in addition to the primary `cache` action:
+>
+>* [Restore action](./restore/README.md)
+>* [Save action](./save/README.md)
+
+[![Tests](https://github.com/actions/cache/actions/workflows/workflow.yml/badge.svg)](https://github.com/actions/cache/actions/workflows/workflow.yml)
 
 ## Documentation
 
+See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows).
+
+## What's New
+
+### ⚠️ Important changes
+
+The cache backend service has been rewritten from the ground up for improved performance and reliability. [actions/cache](https://github.com/actions/cache) now integrates with the new cache service (v2) APIs.
+
+The new service will gradually roll out as of **February 1st, 2025**. The legacy service will also be sunset on the same date. Changes in these release are **fully backward compatible**.
+
+**We are deprecating some versions of this action**. We recommend upgrading to version `v4` or `v3` as soon as possible before **February 1st, 2025.** (Upgrade instructions below).
+
+If you are using pinned SHAs, please use the SHAs of versions `v4.2.0` or `v3.4.0`
+
+If you do not upgrade, all workflow runs using any of the deprecated [actions/cache](https://github.com/actions/cache) will fail.
+
+Upgrading to the recommended versions will not break your workflows.
+
+Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/cache/discussions/1510).
+
+### v3
+
+* Integrated with the new cache service (v2) APIs.
+* Added support for caching in GHES 3.5+.
+* Fixed download issue for files > 2GB during restore.
+* 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_MINS`. Default is 10 minutes.
+* New actions are available for granular control over caches - [restore](restore/action.yml) and [save](save/action.yml).
+* Support cross-os caching as an opt-in feature. See [Cross OS caching](./tips-and-workarounds.md#cross-os-cache) for more info.
+* Added option to fail job on cache miss. See [Exit workflow on cache miss](./restore/README.md#exit-workflow-on-cache-miss) for more info.
+* Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners
+* Added option to lookup cache without downloading it.
+* Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.
+
+See the [v2 README.md](https://github.com/actions/cache/blob/v2/README.md) for older updates.
+
+## Usage
+
+### Pre-requisites
+
+Create a workflow `.yml` file in your repository's `.github/workflows` directory. An [example workflow](#example-cache-workflow) is available below. For more information, see the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
+
+If you are using this inside a container, a POSIX-compliant `tar` needs to be included and accessible from the execution path.
+
+If you are using a `self-hosted` Windows runner, `GNU tar` and `zstd` are required for [Cross-OS caching](https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cross-os-cache) to work. They are also recommended to be installed in general so the performance is on par with `hosted` Windows runners.
+
 ### Inputs
 
-* `key` - An explicit key for a cache entry. See [creating a cache key](../README.md#creating-a-cache-key).
+* `key` - An explicit key for a cache entry. See [creating a cache key](#creating-a-cache-key).
-* `path` - A list of files, directories, and wildcard patterns to cache. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
+* `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.
-* `upload-chunk-size` - The chunk size used to split up large files during upload, in bytes
+* `restore-keys` - An ordered list of prefix-matched keys to use for restoring stale cache if no cache hit occurred for key.
+* `enableCrossOsArchive` - An optional boolean when enabled, allows Windows runners to save or restore caches that can be restored or saved respectively on other platforms. Default: `false`
+* `fail-on-cache-miss` - Fail the workflow if cache entry is not found. Default: `false`
+* `lookup-only` - If true, only checks if cache entry exists and skips download. Does not change save cache behavior. Default: `false`
+
+#### Environment Variables
+
+* `SEGMENT_DOWNLOAD_TIMEOUT_MINS` - Segment download timeout (in minutes, default `10`) to abort download of the segment if not completed in the defined number of minutes. [Read more](https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cache-segment-restore-timeout)
 
 ### Outputs
 
-This action has no outputs.
+* `cache-hit` - A boolean value to indicate an exact match was found for the key.
 
-## Use cases
+    > **Note** `cache-hit` will only be set to `true` when a cache hit occurs for the exact `key` match. For a partial key match via `restore-keys` or a cache miss, it will be set to `false`.
 
+See [Skipping steps based on cache-hit](#skipping-steps-based-on-cache-hit) for info on using this output
 
-### Only save cache
+### Cache scopes
 
-If you are using separate jobs for generating common artifacts and sharing them across jobs, this action will take care of your cache saving needs.
+The cache is scoped to the key, [version](#cache-version), and branch. The default branch cache is available to other branches.
+
+See [Matching a cache key](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key) for more info.
+
+### Example cache workflow
+
+#### Restoring and saving cache using a single action
+
+```yaml
+name: Caching Primes
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Cache Primes
+      id: cache-primes
+      uses: actions/cache@v3
+      with:
+        path: prime-numbers
+        key: ${{ runner.os }}-primes
+
+    - name: Generate Prime Numbers
+      if: steps.cache-primes.outputs.cache-hit != 'true'
+      run: /generate-primes.sh -d prime-numbers
+
+    - name: Use Prime Numbers
+      run: /primes.sh -d prime-numbers
+```
+
+The `cache` action provides a `cache-hit` output which is set to `true` when the cache is restored using the primary `key` and `false` when the cache is restored using `restore-keys` or no cache is restored.
+
+#### Using a combination of restore and save actions
+
+```yaml
+name: Caching Primes
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Restore cached Primes
+      id: cache-primes-restore
+      uses: actions/cache/restore@v3
+      with:
+        path: |
+          path/to/dependencies
+          some/other/dependencies
+        key: ${{ runner.os }}-primes
+    .
+    . //intermediate workflow steps
+    .
+    - name: Save Primes
+      id: cache-primes-save
+      uses: actions/cache/save@v3
+      with:
+        path: |
+          path/to/dependencies
+          some/other/dependencies
+        key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}
+```
+
+> **Note**
+> You must use the `cache` or `restore` action in your workflow before you need to use the files that might be restored from the cache. If the provided `key` matches an existing cache, a new cache is not created and if the provided `key` doesn't match an existing cache, a new cache is automatically created provided the job completes successfully.
+
+## Caching Strategies
+
+With the introduction of the `restore` and `save` actions, a lot of caching use cases can now be achieved. Please see the [caching strategies](./caching-strategies.md) document for understanding how you can use the actions strategically to achieve the desired goal.
+
+## Implementation Examples
+
+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)
+* [Go - Modules](./examples.md#go---modules)
+* [Haskell - Cabal](./examples.md#haskell---cabal)
+* [Haskell - Stack](./examples.md#haskell---stack)
+* [Java - Gradle](./examples.md#java---gradle)
+* [Java - Maven](./examples.md#java---maven)
+* [Node - npm](./examples.md#node---npm)
+* [Node - Lerna](./examples.md#node---lerna)
+* [Node - Yarn](./examples.md#node---yarn)
+* [OCaml/Reason - esy](./examples.md#ocamlreason---esy)
+* [PHP - Composer](./examples.md#php---composer)
+* [Python - pip](./examples.md#python---pip)
+* [Python - pipenv](./examples.md#python---pipenv)
+* [R - renv](./examples.md#r---renv)
+* [Ruby - Bundler](./examples.md#ruby---bundler)
+* [Rust - Cargo](./examples.md#rust---cargo)
+* [Scala - SBT](./examples.md#scala---sbt)
+* [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage)
+* [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods)
+* [Swift - Swift Package Manager](./examples.md#swift---swift-package-manager)
+* [Swift - Mint](./examples.md#swift---mint)
+
+## Creating a cache key
+
+A cache key can include any of the contexts, functions, literals, and operators supported by GitHub Actions.
+
+For example, using the [`hashFiles`](https://docs.github.com/en/actions/learn-github-actions/expressions#hashfiles) function allows you to create a new cache when dependencies change.
+
+```yaml
+  - uses: actions/cache@v3
+    with:
+      path: |
+        path/to/dependencies
+        some/other/dependencies
+      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+```
+
+Additionally, you can use arbitrary command output in a cache key, such as a date or software version:
+
+```yaml
+  # http://man7.org/linux/man-pages/man1/date.1.html
+  - name: Get Date
+    id: get-date
+    run: |
+      echo "date=$(/bin/date -u "+%Y%m%d")" >> $GITHUB_OUTPUT
+    shell: bash
+
+  - uses: actions/cache@v3
+    with:
+      path: path/to/dependencies
+      key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('**/lockfiles') }}
+```
+
+See [Using contexts to create cache keys](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#using-contexts-to-create-cache-keys)
+
+## Cache Limits
+
+A repository can have up to 10GB of caches. Once the 10GB limit is reached, older caches will be evicted based on when the cache was last accessed.  Caches that are not accessed within the last week will also be evicted.
+
+## Skipping steps based on cache-hit
+
+Using the `cache-hit` output, subsequent steps (such as install or build) can be skipped when a cache hit occurs on the key.  It is recommended to install missing/updated dependencies in case of a partial key match when the key is dependent on the `hash` of the package file.
+
+Example:
 
 ```yaml
 steps:
   - uses: actions/checkout@v3
 
-  - name: Install Dependencies
+  - uses: actions/cache@v3
-    run: /install.sh
-
-  - name: Build artifacts
-    run: /build.sh
-
-  - uses: actions/cache/save@v3
     id: cache
     with:
       path: path/to/dependencies
       key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+
+  - name: Install Dependencies
+    if: steps.cache.outputs.cache-hit != 'true'
+    run: /install.sh
 ```
 
-### Re-evaluate cache key while saving
+> **Note** The `id` defined in `actions/cache` must match the `id` in the `if` statement (i.e. `steps.[ID].outputs.cache-hit`)
 
-With this save action, the key can now be re-evaluated while executing the action. This helps in cases where lockfiles are generated during the build.
+## Cache Version
 
-Let's say we have a restore step that computes a key at runtime.
+Cache version is a hash [generated](https://github.com/actions/toolkit/blob/500d0b42fee2552ae9eeb5933091fe2fbf14e72d/packages/cache/src/internal/cacheHttpClient.ts#L73-L90) for a combination of compression tool used (Gzip, Zstd, etc. based on the runner OS) and the `path` of directories being cached. If two caches have different versions, they are identified as unique caches while matching. This, for example, means that a cache created on a `windows-latest` runner can't be restored on `ubuntu-latest` as cache `Version`s are different.
 
-#### Restore a cache
+> Pro tip: The [list caches](https://docs.github.com/en/rest/actions/cache#list-github-actions-caches-for-a-repository) API can be used to get the version of a cache. This can be helpful to troubleshoot cache miss due to version.
-
+
-```yaml
+<details>
-uses: actions/cache/restore@v3
+  <summary>Example</summary>
-id: restore-cache
+The workflow will create 3 unique caches with same keys. Ubuntu and windows runners will use different compression technique and hence create two different caches. And `build-linux` will create two different caches as the `paths` are different.
-with:
-    key: cache-${{ hashFiles('**/lockfiles') }}
-```
-
-#### Case 1 - Where a user would want to reuse the key as it is
-```yaml
-uses: actions/cache/save@v3
-with:
-    key: ${{ steps.restore-cache.outputs.cache-primary-key }}
-```
-
-#### Case 2 - Where the user would want to re-evaluate the key
-
-```yaml
-uses: actions/cache/save@v3
-with:
-    key: npm-cache-${{hashfiles(package-lock.json)}}
-```
-
-### Always save cache
-
-There are instances where some flaky test cases would fail the entire workflow and users would get frustrated because the builds would run for hours and the cache couldn't be saved as the workflow failed in between. For such use-cases, users now have the ability to use the `actions/cache/save` action to save the cache by using an `if: always()` condition. This way the cache will always be saved if generated, or a warning will be generated that nothing is found on the cache path. Users can also use the `if` condition to only execute the `actions/cache/save` action depending on the output of previous steps. This way they get more control of when to save the cache.
 
 ```yaml
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-  .
+
-  . // restore if need be
+      - name: Cache Primes
-  .
+        id: cache-primes
-  - name: Build
+        uses: actions/cache@v3
-    run: /build.sh
-  - uses: actions/cache/save@v3
-    if: always() // or any other condition to invoke the save action
         with:
-      path: path/to/dependencies
+          path: prime-numbers
-      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+          key: primes
+
+      - name: Generate Prime Numbers
+        if: steps.cache-primes.outputs.cache-hit != 'true'
+        run: ./generate-primes.sh -d prime-numbers
+
+      - name: Cache Numbers
+        id: cache-numbers
+        uses: actions/cache@v3
+        with:
+          path: numbers
+          key: primes
+
+      - name: Generate Numbers
+        if: steps.cache-numbers.outputs.cache-hit != 'true'
+        run: ./generate-primes.sh -d numbers
+
+  build-windows:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Cache Primes
+        id: cache-primes
+        uses: actions/cache@v3
+        with:
+          path: prime-numbers
+          key: primes
+
+      - name: Generate Prime Numbers
+        if: steps.cache-primes.outputs.cache-hit != 'true'
+        run: ./generate-primes -d prime-numbers
 ```
+
+</details>
+
+## Known practices and workarounds
+
+There are a number of community practices/workarounds to fulfill specific requirements. You may choose to use them if they suit your use case. Note these are not necessarily the only solution or even a recommended solution.
+
+* [Cache segment restore timeout](./tips-and-workarounds.md#cache-segment-restore-timeout)
+* [Update a cache](./tips-and-workarounds.md#update-a-cache)
+* [Use cache across feature branches](./tips-and-workarounds.md#use-cache-across-feature-branches)
+* [Cross OS cache](./tips-and-workarounds.md#cross-os-cache)
+* [Force deletion of caches overriding default cache eviction policy](./tips-and-workarounds.md#force-deletion-of-caches-overriding-default-cache-eviction-policy)
+
+### Windows environment variables
+
+Please note that Windows environment variables (like `%LocalAppData%`) will NOT be expanded by this action. Instead, prefer using `~` in your paths which will expand to the HOME directory. For example, instead of `%LocalAppData%`, use `~\AppData\Local`. For a list of supported default environment variables, see the [Learn GitHub Actions: Variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) page.
+
+## 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.
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)

RELEASES.md

@@ -1,156 +1,81 @@
 # Releases
 
-## How to prepare a release
+### 3.5.0
 
-> [!NOTE]  
+- Upgraded `@actions/cache` to v4.1.0 to integrate with the new cache service (v2) APIs & remove client side 10GiB cache size limit.
-> Relevant for maintainers with write access only.
 
-1. Switch to a new branch from `main`.
+### 3.0.0
-1. Run `npm test` to ensure all tests are passing.
-1. Update the version in [`package.json`](package.json).
-1. Run `npm run build` to update the compiled files.
-1. Update this [`RELEASES.md`](RELEASES.md) with the new version and changes in the `## Changelog` section.
-1. Run `licensed cache` to update the license report.
-1. Run `licensed status` and resolve any warnings by updating the [`.licensed.yml`](.licensed.yml) file with the exceptions.
-1. Commit your changes and push your branch upstream.
-1. Open a pull request against `main` and get it reviewed and merged.
-1. Draft a new release https://github.com/actions/cache/releases use the same version number used in `package.json`
-    1. Create a new tag with the version number.
-    1. Auto generate release notes and update them to match the changes you made in `RELEASES.md`.
-    1. Toggle the set as the latest release option.
-    1. Publish the release.
-1. Navigate to https://github.com/actions/cache/actions/workflows/release-new-action-version.yml
-    1. There should be a workflow run queued with the same version number.
-    1. Approve the run to publish the new version and update the major tags for this action. 
 
-## Changelog
+- Updated minimum runner version support from node 12 -> node 16
 
-### 5.0.4
+### 3.0.1
 
-- Bump `minimatch` to v3.1.5 (fixes ReDoS via globstar patterns)
+- Added support for caching from GHES 3.5.
-- Bump `undici` to v6.24.1 (WebSocket decompression bomb protection, header validation fixes)
+- Fixed download issue for files > 2GB during restore.
-- Bump `fast-xml-parser` to v5.5.6
 
-### 5.0.3
+### 3.0.2
 
-- Bump `@actions/cache` to v5.0.5 (Resolves: https://github.com/actions/cache/security/dependabot/33)
+- Added support for dynamic cache size cap on GHES.
-- Bump `@actions/core` to v2.0.3
 
-### 5.0.2
+### 3.0.3
 
-- Bump `@actions/cache` to v5.0.3 [#1692](https://github.com/actions/cache/pull/1692)
+- Fixed avoiding empty cache save when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))
 
-### 5.0.1
+### 3.0.4
 
-- Update `@azure/storage-blob` to `^12.29.1` via `@actions/cache@5.0.1` [#1685](https://github.com/actions/cache/pull/1685)
+- 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))
 
-### 5.0.0
+### 3.0.5
 
-> [!IMPORTANT]
+- 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))
-> `actions/cache@v5` runs on the Node.js 24 runtime and requires a minimum Actions Runner version of `2.327.1`.
-> If you are using self-hosted runners, ensure they are updated before upgrading.
 
-### 4.3.0
+### 3.0.6
 
-- Bump `@actions/cache` to [v4.1.0](https://github.com/actions/toolkit/pull/2132)
+- 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
 
-### 4.2.4
+### 3.0.7
 
-- Bump `@actions/cache` to v4.0.5
+- 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.
 
-### 4.2.3
+### 3.0.8
 
-- Bump `@actions/cache` to v4.0.3 (obfuscates SAS token in debug logs for cache entries)
+- 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_MINS`. Default is 60 minutes.
 
-### 4.2.2
+### 3.0.9
 
-- Bump `@actions/cache` to v4.0.2
+- Enhanced the warning message for cache unavailablity in case of GHES.
 
-### 4.2.1
+### 3.0.10
 
-- Bump `@actions/cache` to v4.0.1
+- Fix a bug with sorting inputs.
+- Update definition for restore-keys in README.md
 
-### 4.2.0
+### 3.0.11
 
-TLDR; The cache backend service has been rewritten from the ground up for improved performance and reliability. [actions/cache](https://github.com/actions/cache) now integrates with the new cache service (v2) APIs.
+- 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`
 
-The new service will gradually roll out as of **February 1st, 2025**. The legacy service will also be sunset on the same date. Changes in these release are **fully backward compatible**.
+### 3.1.0-beta.1
 
-**We are deprecating some versions of this action**. We recommend upgrading to version `v4` or `v3` as soon as possible before **February 1st, 2025.** (Upgrade instructions below).
+- 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))
 
-If you are using pinned SHAs, please use the SHAs of versions `v4.2.0` or `v3.4.0`
+### 3.1.0-beta.2
 
-If you do not upgrade, all workflow runs using any of the deprecated [actions/cache](https://github.com/actions/cache) will fail.
+- Added support for fallback to gzip to restore old caches on windows.
 
-Upgrading to the recommended versions will not break your workflows.
+### 3.1.0-beta.3
 
-### 4.1.2
+- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows.
 
-- Add GitHub Enterprise Cloud instances hostname filters to inform API endpoint choices - [#1474](https://github.com/actions/cache/pull/1474)
+### 3.2.0-beta.1
-- Security fix: Bump braces from 3.0.2 to 3.0.3 - [#1475](https://github.com/actions/cache/pull/1475)
 
-### 4.1.1
+- Added two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache.
 
-- Restore original behavior of `cache-hit` output - [#1467](https://github.com/actions/cache/pull/1467)
+### 3.2.0
 
-### 4.1.0
+- Released the two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache
-
-- Ensure `cache-hit` output is set when a cache is missed - [#1404](https://github.com/actions/cache/pull/1404)
-- Deprecate `save-always` input - [#1452](https://github.com/actions/cache/pull/1452)
-
-### 4.0.2
-
-- Fixed restore `fail-on-cache-miss` not working.
-
-### 4.0.1
-
-- Updated `isGhes` check
-
-### 4.0.0
-
-- Updated minimum runner version support from node 12 -> node 20
-
-### 3.4.0
-
-- Integrated with the new cache service (v2) APIs
-
-### 3.3.3
-
-- Updates @actions/cache to v3.2.3 to fix accidental mutated path arguments to `getCacheVersion` [actions/toolkit#1378](https://github.com/actions/toolkit/pull/1378)
-- Additional audit fixes of npm package(s)
-
-### 3.3.2
-
-- Fixes bug with Azure SDK causing blob downloads to get stuck.
-
-### 3.3.1
-
-- Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.
-
-### 3.3.0
-
-- Added option to lookup cache without downloading it.
-
-### 3.2.6
-
-- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners.
-
-### 3.2.5
-
-- Added fix to prevent from setting MYSYS environment variable globally.
-
-### 3.2.4
-
-- Added option to fail job on cache miss.
-
-### 3.2.3
-
-- Support cross os caching on Windows as an opt-in feature.
-- Fix issue with symlink restoration on Windows for cross-os caches.
-
-### 3.2.2
-
-- Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows.
 
 ### 3.2.1
 
@@ -158,75 +83,44 @@ Upgrading to the recommended versions will not break your workflows.
 - Added support for fallback to gzip to restore old caches on windows.
 - Added logs for cache version in case of a cache miss.
 
-### 3.2.0
+### 3.2.2
 
-- Released the two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache
+- Reverted the changes made in 3.2.1 to use gnu tar and zstd by default on windows.
 
-### 3.2.0-beta.1
+### 3.2.3
 
-- Added two new actions - [restore](restore/action.yml) and [save](save/action.yml) for granular control on cache.
+- Support cross os caching on Windows as an opt-in feature.
+- Fix issue with symlink restoration on Windows for cross-os caches.
 
-### 3.1.0-beta.3
+### 3.2.4
 
-- Bug fixes for bsdtar fallback if gnutar not available and gzip fallback if cache saved using old cache action on windows.
+- Added option to fail job on cache miss.
 
-### 3.1.0-beta.2
+### 3.2.5
 
-- Added support for fallback to gzip to restore old caches on windows.
+- Added fix to prevent from setting MYSYS environment variable globally.
 
-### 3.1.0-beta.1
+### 3.2.6
 
-- 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))
+- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners.
 
-### 3.0.11
+### 3.3.0
 
-- Update toolkit version to 3.0.5 to include `@actions/core@^1.10.0`
+- Added option to lookup cache without downloading it.
-- Update `@actions/cache` to use updated `saveState` and `setOutput` functions from `@actions/core@^1.10.0`
 
-### 3.0.10
+### 3.3.1
 
-- Fix a bug with sorting inputs.
+- Reduced segment size to 128MB and segment timeout to 10 minutes to fail fast in case the cache download is stuck.
-- Update definition for restore-keys in README.md
 
-### 3.0.9
+### 3.3.2
 
-- Enhanced the warning message for cache unavailablity in case of GHES.
+- Fixes bug with Azure SDK causing blob downloads to get stuck.
 
-### 3.0.8
+### 3.3.3
 
-- 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).
+- Updates @actions/cache to v3.2.3 to fix accidental mutated path arguments to `getCacheVersion` [actions/toolkit#1378](https://github.com/actions/toolkit/pull/1378)
-- Allowing users to provide a custom timeout as input for aborting download of a cache segment using an environment variable `SEGMENT_DOWNLOAD_TIMEOUT_MINS`. Default is 60 minutes.
+- Additional audit fixes of npm package(s)
 
-### 3.0.7
+### 3.4.0
 
-- 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.
+- Integrated with the new cache service (v2) APIs
-
-### 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.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))
-
-### 3.0.4
-
-- 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.3
-
-- Fixed avoiding empty cache save when no files are available for caching. ([issue](https://github.com/actions/cache/issues/624))
-
-### 3.0.2
-
-- Added support for dynamic cache size cap on GHES.
-
-### 3.0.1
-
-- Added support for caching from GHES 3.5.
-- Fixed download issue for files > 2GB during restore.
-
-### 3.0.0
-
-- Updated minimum runner version support from node 12 -> node 16

action.yml

@@ -1,23 +1,39 @@
-name: 'Save a cache'
+name: 'Cache'
-description: 'Save Cache artifacts like dependencies and build outputs to improve workflow execution time'
+description: 'Cache artifacts like dependencies and build outputs to improve workflow execution time'
 author: 'GitHub'
 inputs:
   path:
-    description: 'A list of files, directories, and wildcard patterns to cache'
+    description: 'A list of files, directories, and wildcard patterns to cache and restore'
     required: true
   key:
-    description: 'An explicit key for saving the cache'
+    description: 'An explicit key for restoring and saving the cache'
     required: true
+  restore-keys:
+    description: '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.'
+    required: false
   upload-chunk-size:
     description: 'The chunk size used to split up large files during upload, in bytes'
     required: false
   enableCrossOsArchive:
-    description: 'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms'
+    description: 'An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms'
     default: 'false'
     required: false
+  fail-on-cache-miss:
+    description: 'Fail the workflow if cache entry is not found'
+    default: 'false'
+    required: false
+  lookup-only:
+    description: 'Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache'
+    default: 'false'
+    required: false
+outputs:
+  cache-hit:
+    description: 'A boolean value to indicate an exact match was found for the primary key'
 runs:
   using: 'node16'
-  main: '../dist/save-only/index.js'
+  main: 'dist/restore/index.js'
+  post: 'dist/save/index.js'
+  post-if: success()
 branding:
   icon: 'archive'
   color: 'gray-dark'

actionUtils.ts

@@ -7,13 +7,7 @@ export function isGhes(): boolean {
     const ghUrl = new URL(
         process.env["GITHUB_SERVER_URL"] || "https://github.com"
     );
-
+    return ghUrl.hostname.toUpperCase() !== "GITHUB.COM";
-    const hostname = ghUrl.hostname.trimEnd().toUpperCase();
-    const isGitHubHost = hostname === "GITHUB.COM";
-    const isGitHubEnterpriseCloudHost = hostname.endsWith(".GHE.COM");
-    const isLocalHost = hostname.endsWith(".LOCALHOST");
-
-    return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
 }
 
 export function isExactKeyMatch(key: string, cacheKey?: string): boolean {

caching-strategies.md

@@ -12,7 +12,7 @@ This document lists some of the strategies (and example workflows if possible) w
 jobs:
   build:
     runs-on: ubuntu-latest
-    - uses: actions/cache@v5
+    - uses: actions/cache@v3
       with:
         key: ${{ some-metadata }}-cache
 ```
@@ -24,7 +24,7 @@ In your workflows, you can use different strategies to name your key depending o
 One of the most common use case is to use hash for lockfile as key. This way, same cache will be restored for a lockfile until there's a change in dependencies listed in lockfile.
 
 ```yaml
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -37,7 +37,7 @@ One of the most common use case is to use hash for lockfile as key. This way, sa
 If cache is not found matching the primary key, restore keys can be used to download the closest matching cache that was recently created. This ensures that the build/install step will need to additionally fetch just a handful of newer dependencies, and hence saving build time.
 
 ```yaml
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -54,7 +54,7 @@ The restore keys can be provided as a complete name, or a prefix, read more [her
 In case of workflows with matrix running for multiple Operating Systems, the caches can be stored separately for each of them. This can be used in combination with hashfiles in case multiple caches are being generated per OS.
 
 ```yaml
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -73,7 +73,7 @@ Caches scoped to the particular workflow run id or run attempt can be stored and
 On similar lines, commit sha can be used to create a very specialized and short lived cache.
 
 ```yaml
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -81,12 +81,12 @@ On similar lines, commit sha can be used to create a very specialized and short
       key: cache-${{ github.sha }}
 ```
 
-### Using multiple factors while forming a key depending on the need
+### Using multiple factors while forming a key depening on the need
 
 Cache key can be formed by combination of more than one metadata, evaluated info.
 
 ```yaml
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: |
         path/to/dependencies
@@ -102,7 +102,7 @@ The [GitHub Context](https://docs.github.com/en/actions/learn-github-actions/con
 
 While setting paths for caching dependencies it is important to give correct path depending on the hosted runner you are using or whether the action is running in a container job. Assigning different `path` for save and restore will result in cache miss.
 
-Below are GitHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
+Below are GiHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
 
 #### Ubuntu Paths
 
@@ -146,9 +146,9 @@ In case you are using a centralized job to create and save your cache that can b
 
 ```yaml
 steps:
-  - uses: actions/checkout@v6
+  - uses: actions/checkout@v3
 
-  - uses: actions/cache/restore@v5
+  - uses: actions/cache/restore@v3
     id: cache
     with:
       path: path/to/dependencies
@@ -171,9 +171,9 @@ You can use the output of this action to exit the workflow on cache miss. This w
 
 ```yaml
 steps:
-  - uses: actions/checkout@v6
+  - uses: actions/checkout@v3
 
-  - uses: actions/cache/restore@v5
+  - uses: actions/cache/restore@v3
     id: cache
     with:
       path: path/to/dependencies
@@ -194,7 +194,7 @@ steps:
 If you want to avoid re-computing the cache key again in `save` action, the outputs from `restore` action can be used as input to the `save` action.
 
 ```yaml
-  - uses: actions/cache/restore@v5
+  - uses: actions/cache/restore@v3
     id: restore-cache
     with:
       path: |
@@ -204,7 +204,7 @@ If you want to avoid re-computing the cache key again in `save` action, the outp
   .
   .
   .
-  - uses: actions/cache/save@v5
+  - uses: actions/cache/save@v3
     with:
       path: |
         path/to/dependencies
@@ -219,7 +219,7 @@ On the other hand, the key can also be explicitly re-computed while executing th
 Let's say we have a restore step that computes key at runtime
 
 ```yaml
-uses: actions/cache/restore@v5
+uses: actions/cache/restore@v3
 id: restore-cache
 with:
     key: cache-${{ hashFiles('**/lockfiles') }}
@@ -228,7 +228,7 @@ with:
 Case 1: Where an user would want to reuse the key as it is
 
 ```yaml
-uses: actions/cache/save@v5
+uses: actions/cache/save@v3
 with:
     key: ${{ steps.restore-cache.outputs.cache-primary-key }}
 ```
@@ -236,14 +236,31 @@ with:
 Case 2: Where the user would want to re-evaluate the key
 
 ```yaml
-uses: actions/cache/save@v5
+uses: actions/cache/save@v3
 with:
     key: npm-cache-${{hashfiles(package-lock.json)}}
 ```
 
 ### Saving cache even if the build fails
 
-See [Always save cache](./save/README.md#always-save-cache).
+There can be cases where a cache should be saved even if the build job fails. For example, a job can fail due to flaky tests but the caches can still be re-used. You can use `actions/cache/save` action to save the cache by using `if: always()` condition.
+
+Similarly, `actions/cache/save` action can be conditionally used based on the output of the previous steps. This way you get more control on when to save the cache.
+
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  .
+  . // restore if need be
+  .
+  - name: Build
+    run: /build.sh
+  - uses: actions/cache/save@v3
+    if: always() // or any other condition to invoke the save action
+    with:
+      path: path/to/dependencies
+      key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+```
 
 ### Saving cache once and reusing in multiple workflows
 
@@ -253,12 +270,12 @@ In case of multi-module projects, where the built artifact of one project needs
 
 ```yaml
 steps:
-  - uses: actions/checkout@v6
+  - uses: actions/checkout@v3
 
   - name: Build
     run: ./build-parent-module.sh
 
-  - uses: actions/cache/save@v5
+  - uses: actions/cache/save@v3
     id: cache
     with:
       path: path/to/dependencies
@@ -269,9 +286,9 @@ steps:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v6
+  - uses: actions/checkout@v3
 
-  - uses: actions/cache/restore@v5
+  - uses: actions/cache/restore@v3
     id: cache
     with:
       path: path/to/dependencies

examples.md

@@ -1,6 +1,5 @@
 # Examples
 
-- [Bun](#bun)
 - [C# - NuGet](#c---nuget)
 - [Clojure - Lein Deps](#clojure---lein-deps)
 - [D - DUB](#d---dub)
@@ -42,32 +41,12 @@
 - [Swift - Mint](#swift---mint)
 - [* - Bazel](#---bazel)
 
-## Bun
-
-```yaml
-- uses: actions/cache@v5
-  with:
-    path: |
-      ~/.bun/install/cache
-    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
-```
-
-### Windows
-
-```yaml
-- uses: actions/cache@v5
-  with:
-    path: |
-      ~\.bun
-    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
-```
-
 ## C# - NuGet
 
 Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies):
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ~/.nuget/packages
     key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
@@ -76,10 +55,10 @@ Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/packa
 ```
 
 Depending on the environment, huge packages might be pre-installed in the global cache folder.
-From `actions/cache@v3` onwards, you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
+With `actions/cache@v3` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.nuget/packages
@@ -96,7 +75,7 @@ Or you could move the cache folder like below.
 env:
   NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
 steps:
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: ${{ github.workspace }}/.nuget/packages
       key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
@@ -108,7 +87,7 @@ steps:
 
 ```yaml
 - name: Cache lein project dependencies
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: ~/.m2/repository
     key: ${{ runner.os }}-clojure-${{ hashFiles('**/project.clj') }}
@@ -122,7 +101,7 @@ steps:
 ### POSIX
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ~/.dub
     key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.selections.json') }}
@@ -133,7 +112,7 @@ steps:
 ### Windows
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ~\AppData\Local\dub
     key: ${{ runner.os }}-dub-${{ hashFiles('**/dub.selections.json') }}
@@ -146,7 +125,7 @@ steps:
 ### Linux
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.deno
@@ -157,7 +136,7 @@ steps:
 ### macOS
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.deno
@@ -168,7 +147,7 @@ steps:
 ### Windows
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~\.deno
@@ -179,7 +158,7 @@ steps:
 ## Elixir - Mix
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       deps
@@ -191,7 +170,7 @@ steps:
 
 ## Erlang - Rebar3
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v2
   with:
     path: |
       ~/.cache/rebar3
@@ -206,7 +185,7 @@ steps:
 ### Linux
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.cache/go-build
@@ -219,7 +198,7 @@ steps:
 ### macOS
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/Library/Caches/go-build
@@ -232,7 +211,7 @@ steps:
 ### Windows
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~\AppData\Local\go-build
@@ -248,7 +227,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 
 ```yaml
 - name: Cache ~/.cabal/packages, ~/.cabal/store and dist-newstyle
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: |
       ~/.cabal/packages
@@ -263,14 +242,14 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 ### Linux or macOS
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   name: Cache ~/.stack
   with:
     path: ~/.stack
     key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
     restore-keys: |
       ${{ runner.os }}-stack-global-
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   name: Cache .stack-work
   with:
     path: .stack-work
@@ -282,7 +261,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 ### Windows
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   name: Cache %APPDATA%\stack %LOCALAPPDATA%\Programs\stack
   with:
     path: |
@@ -291,7 +270,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
     key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
     restore-keys: |
       ${{ runner.os }}-stack-global-
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   name: Cache .stack-work
   with:
     path: .stack-work
@@ -305,7 +284,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 > **Note** Ensure no Gradle daemons are running anymore when your workflow completes. Creating the cache package might fail due to locks being held by Gradle. Refer to the [Gradle Daemon documentation](https://docs.gradle.org/current/userguide/gradle_daemon.html) on how to disable or stop the Gradle Daemons.
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.gradle/caches
@@ -319,7 +298,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
 
 ```yaml
 - name: Cache local Maven repository
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: ~/.m2/repository
     key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -355,7 +334,7 @@ After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-depr
 `Get npm cache directory` step can then be used with `actions/cache` as shown below
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
   with:
     path: ${{ steps.npm-cache-dir.outputs.dir }}
@@ -368,7 +347,7 @@ After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-depr
 
 ```yaml
 - name: restore lerna
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: '**/node_modules'
     key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
@@ -382,7 +361,7 @@ The yarn cache directory will depend on your operating system and version of `ya
   id: yarn-cache-dir-path
   run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
 
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
   with:
     path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -400,7 +379,7 @@ The yarn 2 cache directory will depend on your config. See https://yarnpkg.com/c
   id: yarn-cache-dir-path
   run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
 
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
   with:
     path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -415,7 +394,7 @@ Esy allows you to export built dependencies and import pre-built dependencies.
 ```yaml
     - name: Restore Cache
       id: restore-cache
-      uses: actions/cache@v5
+      uses: actions/cache@v3
       with:
         path: _export
         key:  ${{ runner.os }}-esy-${{ hashFiles('esy.lock/index.json') }}
@@ -444,7 +423,7 @@ Esy allows you to export built dependencies and import pre-built dependencies.
   id: composer-cache
   run: |
     echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ${{ steps.composer-cache.outputs.dir }}
     key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
@@ -465,7 +444,7 @@ Locations:
 ### Simple example
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ~/.cache/pip
     key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -478,7 +457,7 @@ Replace `~/.cache/pip` with the correct `path` if not using Ubuntu.
 ### Multiple OS's in a workflow
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   if: startsWith(runner.os, 'Linux')
   with:
     path: ~/.cache/pip
@@ -486,7 +465,7 @@ Replace `~/.cache/pip` with the correct `path` if not using Ubuntu.
     restore-keys: |
       ${{ runner.os }}-pip-
 
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   if: startsWith(runner.os, 'macOS')
   with:
     path: ~/Library/Caches/pip
@@ -494,7 +473,7 @@ Replace `~/.cache/pip` with the correct `path` if not using Ubuntu.
     restore-keys: |
       ${{ runner.os }}-pip-
 
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   if: startsWith(runner.os, 'Windows')
   with:
     path: ~\AppData\Local\pip\Cache
@@ -520,7 +499,7 @@ jobs:
         - os: windows-latest
           path: ~\AppData\Local\pip\Cache
     steps:
-    - uses: actions/cache@v5
+    - uses: actions/cache@v3
       with:
         path: ${{ matrix.path }}
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -534,12 +513,11 @@ jobs:
 ```yaml
 - name: Get pip cache dir
   id: pip-cache
-  shell: bash
   run: |
     echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 
 - name: pip cache
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: ${{ steps.pip-cache.outputs.dir }}
     key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -553,11 +531,11 @@ jobs:
 - name: Set up Python
   # The actions/cache step below uses this id to get the exact python version
   id: setup-python
-  uses: actions/setup-python@v6
+  uses: actions/setup-python@v2
 
   ⋮
 
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: ~/.local/share/virtualenvs
     key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-pipenv-${{ hashFiles('Pipfile.lock') }}
@@ -584,7 +562,7 @@ For renv, the cache directory will vary by OS. The `RENV_PATHS_ROOT` environment
     cat("##[set-output name=r-version;]", R.Version()$version.string, sep = "")
   shell: Rscript {0}
 - name: Restore Renv package cache
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: ${{ env.RENV_PATHS_ROOT }}
     key: ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-${{ inputs.cache-version }}-${{ hashFiles('renv.lock') }}
@@ -610,7 +588,7 @@ whenever possible:
 ## Rust - Cargo
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: |
       ~/.cargo/bin/
@@ -625,7 +603,7 @@ whenever possible:
 
 ```yaml
 - name: Cache SBT
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: |
       ~/.ivy2/cache
@@ -636,7 +614,7 @@ whenever possible:
 ## Swift, Objective-C - Carthage
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: Carthage
     key: ${{ runner.os }}-carthage-${{ hashFiles('**/Cartfile.resolved') }}
@@ -647,7 +625,7 @@ whenever possible:
 ## Swift, Objective-C - CocoaPods
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: Pods
     key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
@@ -658,7 +636,7 @@ whenever possible:
 ## Swift - Swift Package Manager
 
 ```yaml
-- uses: actions/cache@v5
+- uses: actions/cache@v3
   with:
     path: .build
     key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
@@ -673,7 +651,7 @@ env:
   MINT_PATH: .mint/lib
   MINT_LINK_PATH: .mint/bin
 steps:
-  - uses: actions/cache@v5
+  - uses: actions/cache@v3
     with:
       path: .mint
       key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }}
@@ -689,7 +667,7 @@ steps:
 
 ```yaml
 - name: Cache Bazel
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: |
       ~/.cache/bazel
@@ -703,7 +681,7 @@ steps:
 
 ```yaml
 - name: Cache Bazel
-  uses: actions/cache@v5
+  uses: actions/cache@v3
   with:
     path: |
       /private/var/tmp/_bazel_runner/

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "5.0.4",
+  "version": "3.5.0",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
@@ -23,32 +23,29 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^5.0.5",
+    "@actions/cache": "^4.1.0",
-    "@actions/core": "^2.0.3",
+    "@actions/core": "^1.11.1",
-    "@actions/exec": "^2.0.0",
+    "@actions/exec": "^1.1.1",
-    "@actions/io": "^2.0.0"
+    "@actions/io": "^1.1.3"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^27.5.2",
     "@types/nock": "^11.1.0",
-    "@types/node": "^24.1.0",
+    "@types/node": "^16.18.3",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^7.2.0",
+    "@typescript-eslint/parser": "^5.45.0",
     "@vercel/ncc": "^0.38.3",
     "eslint": "^8.28.0",
-    "eslint-config-prettier": "^9.1.2",
+    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jest": "^26.9.0",
-    "eslint-plugin-prettier": "^5.5.3",
+    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "jest": "^29.7.0",
+    "jest": "^28.1.3",
-    "jest-circus": "^29.7.0",
+    "jest-circus": "^27.5.1",
     "nock": "^13.2.9",
-    "prettier": "^3.6.2",
+    "prettier": "^2.8.0",
-    "ts-jest": "^29.4.0",
+    "ts-jest": "^28.0.8",
-    "typescript": "^5.8.3"
+    "typescript": "^4.9.3"
-  },
-  "engines": {
-    "node": ">=24"
   }
 }

restoreImpl.ts

@@ -10,8 +10,7 @@ import {
 import * as utils from "./utils/actionUtils";
 
 export async function restoreImpl(
-    stateProvider: IStateProvider,
+    stateProvider: IStateProvider
-    earlyExit?: boolean | undefined
 ): Promise<string | undefined> {
     try {
         if (!utils.isCacheFeatureAvailable()) {
@@ -51,9 +50,6 @@ export async function restoreImpl(
         );
 
         if (!cacheKey) {
-            // `cache-hit` is intentionally not set to `false` here to preserve existing behavior
-            // See https://github.com/actions/cache/issues/1466
-
             if (failOnCacheMiss) {
                 throw new Error(
                     `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${primaryKey}`
@@ -65,6 +61,7 @@ export async function restoreImpl(
                     ...restoreKeys
                 ].join(", ")}`
             );
+
             return;
         }
 
@@ -86,9 +83,6 @@ export async function restoreImpl(
         return cacheKey;
     } catch (error: unknown) {
         core.setFailed((error as Error).message);
-        if (earlyExit) {
-            process.exit(1);
-        }
     }
 }
 
@@ -96,7 +90,14 @@ async function run(
     stateProvider: IStateProvider,
     earlyExit: boolean | undefined
 ): Promise<void> {
-    await restoreImpl(stateProvider, earlyExit);
+    try {
+        await restoreImpl(stateProvider);
+    } catch (err) {
+        console.error(err);
+        if (earlyExit) {
+            process.exit(1);
+        }
+    }
 
     // node will stay alive if any promises are not resolved,
     // which is a possibility if HTTP requests are dangling

save.ts

@@ -1,3 +1,10 @@
-import { saveRun } from "./saveImpl";
+import saveImpl from "./saveImpl";
+import { StateProvider } from "./stateProvider";
 
-saveRun(true);
+async function run(): Promise<void> {
+    await saveImpl(new StateProvider());
+}
+
+run();
+
+export default run;

saveImpl.ts

@@ -2,11 +2,7 @@ import * as cache from "@actions/cache";
 import * as core from "@actions/core";
 
 import { Events, Inputs, State } from "./constants";
-import {
+import { IStateProvider } from "./stateProvider";
-    IStateProvider,
-    NullStateProvider,
-    StateProvider
-} from "./stateProvider";
 import * as utils from "./utils/actionUtils";
 
 // Catch and log any unhandled exceptions.  These exceptions can leak out of the uploadChunk method in
@@ -14,9 +10,7 @@ import * as utils from "./utils/actionUtils";
 // throw an uncaught exception.  Instead of failing this action, just warn.
 process.on("uncaughtException", e => utils.logWarning(e.message));
 
-export async function saveImpl(
+async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
-    stateProvider: IStateProvider
-): Promise<number | void> {
     let cacheId = -1;
     try {
         if (!utils.isCacheFeatureAvailable()) {
@@ -78,47 +72,4 @@ export async function saveImpl(
     return cacheId;
 }
 
-export async function saveOnlyRun(
+export default saveImpl;
-    earlyExit?: boolean | undefined
-): Promise<void> {
-    try {
-        const cacheId = await saveImpl(new NullStateProvider());
-        if (cacheId === -1) {
-            core.warning(`Cache save failed.`);
-        }
-    } catch (err) {
-        console.error(err);
-        if (earlyExit) {
-            process.exit(1);
-        }
-    }
-
-    // node will stay alive if any promises are not resolved,
-    // which is a possibility if HTTP requests are dangling
-    // due to retries or timeouts. We know that if we got here
-    // that all promises that we care about have successfully
-    // resolved, so simply exit with success.
-    if (earlyExit) {
-        process.exit(0);
-    }
-}
-
-export async function saveRun(earlyExit?: boolean | undefined): Promise<void> {
-    try {
-        await saveImpl(new StateProvider());
-    } catch (err) {
-        console.error(err);
-        if (earlyExit) {
-            process.exit(1);
-        }
-    }
-
-    // node will stay alive if any promises are not resolved,
-    // which is a possibility if HTTP requests are dangling
-    // due to retries or timeouts. We know that if we got here
-    // that all promises that we care about have successfully
-    // resolved, so simply exit with success.
-    if (earlyExit) {
-        process.exit(0);
-    }
-}

saveOnly.ts

@@ -1,3 +1,15 @@
-import { saveOnlyRun } from "./saveImpl";
+import * as core from "@actions/core";
 
-saveOnlyRun(true);
+import saveImpl from "./saveImpl";
+import { NullStateProvider } from "./stateProvider";
+
+async function run(): Promise<void> {
+    const cacheId = await saveImpl(new NullStateProvider());
+    if (cacheId === -1) {
+        core.warning(`Cache save failed.`);
+    }
+}
+
+run();
+
+export default run;

tips-and-workarounds.md

@@ -12,7 +12,7 @@ A cache today is immutable and cannot be updated. But some use cases require the
 
   ```yaml
       - name: update cache on every commit
-        uses: actions/cache@v5
+        uses: actions/cache@v3
         with:
           path: prime-numbers
           key: primes-${{ runner.os }}-${{ github.run_id }} # Can use time based key as well
@@ -37,8 +37,9 @@ From `v3.2.3` cache is cross-os compatible when `enableCrossOsArchive` input is
 
 ## Force deletion of caches overriding default cache eviction policy
 
-Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing.
+Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing. In order to achieve this, [gh-actions-cache cli](https://github.com/actions/gh-actions-cache/) can be used to delete caches for specific branches.
 
+This workflow uses `gh-actions-cache` to delete all the caches created by a branch.
 <details>
   <summary>Example</summary>
 
@@ -59,23 +60,29 @@ jobs:
       actions: write
       contents: read
     steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
       - name: Cleanup
         run: |
+          gh extension install actions/gh-actions-cache
+          
+          REPO=${{ github.repository }}
+          BRANCH=refs/pull/${{ github.event.pull_request.number }}/merge
+
           echo "Fetching list of cache key"
-          cacheKeysForPR=$(gh cache list --ref $BRANCH --limit 100 --json id --jq '.[].id')
+          cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
 
           ## Setting this to not fail the workflow while deleting cache keys. 
           set +e
           echo "Deleting caches..."
           for cacheKey in $cacheKeysForPR
           do
-              gh cache delete $cacheKey
+              gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
           done
           echo "Done"
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GH_REPO: ${{ github.repository }}
-          BRANCH: refs/pull/${{ github.event.pull_request.number }}/merge
 ```
 
 </details>