Merge 9efb3f33bc into 638ed79f9d

Merge pull request #1642 from actions/GhadimiR-patch-1
Add note on runner versions
2026-03-10 09:01:46 +08:00 · 2025-08-15 15:05:07 +01:00 · 2025-08-11 12:17:46 +01:00 · 2025-08-11 09:20:59 +01:00 · 2023-11-18 13:31:41 -05:00
1 changed files with 8 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -19,16 +19,19 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac

 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**.
+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 releases 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 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.

+> **Additionally, if you are managing your own GitHub runners, you must update your runner version to `2.231.0` or newer to ensure compatibility with the new cache service.**  
+> Failure to update both the action version and your runner version may result in workflow failures after the migration date.
+
 Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/cache/discussions/1510).

 ### v4
@ -209,6 +212,9 @@ A cache key can include any of the contexts, functions, literals, and operators

 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.

+> [!NOTE]  
+> The cache key is rendered during the restore stage, so can only depend on file state at that stage.
+
 ```yaml
  - uses: actions/cache@v4
    with:
Author	SHA1	Message	Date
Ian Butterworth	2a35c72b5a	Merge `9efb3f33bc` into `638ed79f9d`	2025-08-15 15:05:07 +01:00
Ryan Ghadimi	638ed79f9d	Merge pull request #1642 from actions/GhadimiR-patch-1 Add note on runner versions	2025-08-11 12:17:46 +01:00
Ryan Ghadimi	3862dccb17	Add note on runner versions	2025-08-11 09:20:59 +01:00
Ian Butterworth	9efb3f33bc	Add note about when key is rendered	2023-11-18 13:31:41 -05:00