Merge ce207c8817 into 638ed79f9d

Merge pull request #1642 from actions/GhadimiR-patch-1
Add note on runner versions
2026-06-29 18:13:48 +08:00 · 2025-08-11 20:30:51 +02:00 · 2025-08-11 12:17:46 +01:00 · 2025-08-11 09:20:59 +01:00 · 2021-03-27 16:12:34 +01:00
2 changed files with 14 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
--- a/examples.md
+++ b/examples.md
@@ -563,6 +563,15 @@ jobs:
    key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-pipenv-${{ hashFiles('Pipfile.lock') }}
 ```

+To use the cache effectively:
+```yaml
+- name: Install packages
+  run: |
+    pipenv --venv && \
+      (pipenv lock -r |cat - ci-requirements.txt|pipenv run pip install -r /dev/stdin) || \
+      (pipenv install --python ${{ matrix.python-version }} --deploy)
+```
+
 ## R - renv

 For renv, the cache directory will vary by OS. The `RENV_PATHS_ROOT` environment variable is used to set the cache location. Have a look at https://rstudio.github.io/renv/reference/paths.html#details for more details.
Author	SHA1	Message	Date
Melvyn Sopacua	40c3717e37	Merge `ce207c8817` into `638ed79f9d`	2025-08-11 20:30:51 +02: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
Melvyn Sopacua	ce207c8817	doc(python-pipenv): Add run example Using the cache is only effective when not using install as it will run `pipenv --rm` if it detects an old environment. On top of that, pip is a lot faster at detecting satisfied requirements.	2021-03-27 16:12:34 +01:00