@actions/cache Package Deprecation Notice. Upgrade to the latest 4.0.0 or higher before February 1st 2025 · actions/toolkit · Discussion #1890 (original) (raw)

TLDR; The cache backend service has been rewritten from the ground up for improved performance and reliability. The @actions/cache package 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 this release are fully backward compatible.

All previous versions of this package will be deprecated. We recommend upgrading to version 4.0.0 or higher as soon as possible before March 1st, 2025.

If you do not upgrade, all workflow runs using any of the deprecated @actions/cache packages will fail.

Upgrading to the recommended version should not break or require any changes to your workflows beyond updating your package.json to version 4.0.0 or higher.

Context

The cache backend service has been rewritten from the ground up for improved performance and reliability. In version 4.0.0 of the @actions/cache package, we introduced a more consistent API contract with the cache backend service.

The new service will decrease the cache upload duration by up to ~80% when using GitHub Hosted Runners. The cache download performance will be the same. If you’re using self-hosted runners the upload duration is expected to improve, or in the worst-case stay the same. Cache upload/download performance depends on your network topology, hardware and geographical region used for hosting among other factors.

We will start rolling out the new backend service gradually as of February 1st, 2025. We will issue further guidance as we approach this deadline.

The legacy backend service will be sunset shortly after February 1st, 2025. We will not support both services at the same time. Refer to the migration guide below for further information on how to prevent disruption to your teams.

Migration guide

How to upgrade

The new changes to the @actions/cache package should be seamless and fully backward compatible. You are not expected to change anything in your code to use the new service.

In order to upgrade, simply bump up the version of @actions/cache in your package.json to 4.0.0 (or above). We will be releasing bug fixes and improvements throughout the period leading to February 1st, 2025.

Here is a sample package.json for your reference.

{ "name": "my-github-action", "version": "1.0.0", "description": "A GitHub Action using @actions/cache", "main": "index.js", "scripts": { "test": "echo "Error: no test specified" && exit 1" }, "keywords": [ "github", "actions", "cache" ], "author": "Your Name", "license": "MIT", "dependencies": { "@actions/cache": "^4.0.0" } }

Maintainers of solutions that depend on @actions/cache

Please upgrade the @actions/cache package to 4.0.0 or higher and release new versions of your solutions as soon as possible.

The API changes are backward compatible and enabled via feature flags to facilitate the gradual & safe rollout of the new service.

If you are a maintainer of any setup-* action, please comment on this discussion and we will look into enabling the new service for you on a test repository, so that you can test the change before it's rolled out globally.

All of the previously released versions in the list below are now deprecated:

GitHub Enterprise Server

This deprecation will not impact any existing versions of GitHub Enterprise Server that are currently in use.