github
/
cache
mirror of https://github.com/actions/cache.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README for v5 release with Node 24 and runner version requirements

This commit is contained in:
Salman Muin Kayser Chishti 2025-12-11 21:08:31 +00:00
parent 9e02f8fbde
commit 07629789a8
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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). 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 ### v4
* Integrated with the new cache service (v2) APIs. * Integrated with the new cache service (v2) APIs.
@ -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. 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. 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 ### Inputs