Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update README for v5 release with Node 24 and runner version re…
…quirements
  • Loading branch information
salmanmkc committed Dec 11, 2025
commit 07629789a8e1387a1731ea6c0831e183ebb37e72
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ 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).

### v5

* Updated to node 24
* Requires a minimum Actions Runner version of `2.327.1`

### v4

* Integrated with the new cache service (v2) APIs.
Expand Down Expand Up @@ -69,6 +74,10 @@ Create a workflow `.yml` file in your repository's `.github/workflows` directory

If you are using this inside a container, a POSIX-compliant `tar` needs to be included and accessible from the execution path.

> **Note**
> `actions/cache@v5` runs on Node.js 24 and requires a minimum Actions Runner version of `2.327.1`.
> If you are using self-hosted runners, ensure they are updated before upgrading.

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
Expand Down
Loading