From 4498687c5e855a7e61c31c75acb54b1e30e3f3b3 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Tue, 3 Dec 2024 02:40:00 -0800 Subject: [PATCH 1/6] Prepare @actions/cache 4.0.0 release --- packages/cache/RELEASES.md | 15 +++++++++++++++ packages/cache/package-lock.json | 4 ++-- packages/cache/package.json | 2 +- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/packages/cache/RELEASES.md b/packages/cache/RELEASES.md index 85415952..ebe6f031 100644 --- a/packages/cache/RELEASES.md +++ b/packages/cache/RELEASES.md @@ -1,6 +1,21 @@ # @actions/cache Releases +### 4.0.0 + +#### Important changes + +- The cache backend service has been rewritten from the ground up for improved performance and reliability. This release integrates with the new cache service (v2) APIs. The new service will gradually rollout following the deprecation period. The legacy service will be sunset on **February 1st, 2025**. +- Changes in this release are **fully backward compatible**. Upgrading to this version should not break or require any changes to your workflows beyond updating your `package.json` to this version. +- **All previous versions of this package will be deprecated**. We recommend upgrading to this version as soon as possible before **February 1st, 2025.** + +#### Minor changes + +- Update `@actions/core` to `1.11.0` +- Update `semver` `6.3.1` +- Add `twirp-ts` `2.5.0` to dependencies + ### 3.3.0 + - Update `@actions/core` to `1.11.1` - Remove dependency on `uuid` package [#1824](https://github.com/actions/toolkit/pull/1824), [#1842](https://github.com/actions/toolkit/pull/1842) diff --git a/packages/cache/package-lock.json b/packages/cache/package-lock.json index beb23a68..132391fb 100644 --- a/packages/cache/package-lock.json +++ b/packages/cache/package-lock.json @@ -1,12 +1,12 @@ { "name": "@actions/cache", - "version": "3.3.0", + "version": "4.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@actions/cache", - "version": "3.3.0", + "version": "4.0.0", "license": "MIT", "dependencies": { "@actions/core": "^1.11.1", diff --git a/packages/cache/package.json b/packages/cache/package.json index e5332a92..b03f4221 100644 --- a/packages/cache/package.json +++ b/packages/cache/package.json @@ -1,6 +1,6 @@ { "name": "@actions/cache", - "version": "3.3.0", + "version": "4.0.0", "preview": true, "description": "Actions cache lib", "keywords": [ From cb001af8a39a02d063d4cba5f1151b292c4d022c Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Tue, 3 Dec 2024 02:52:39 -0800 Subject: [PATCH 2/6] Update README to include deprecation notice --- packages/cache/README.md | 8 ++++++-- packages/cache/RELEASES.md | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 55185032..2f7be8df 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -6,6 +6,12 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac Note that GitHub will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 10 GB. If you exceed this limit, GitHub will save your cache but will begin evicting caches until the total size is less than 10 GB. +## Important changes + +- The cache backend service has been rewritten from the ground up for improved performance and reliability. This release integrates with the new cache service (v2) APIs. The new service will gradually rollout following the deprecation period. The legacy service will be sunset on **February 1st, 2025**. +- Changes in the `4.0.0` release are **fully backward compatible**. Upgrading to version `4.0.0` should not break or require any changes to your workflows beyond updating your `package.json` to this version. +- **All previous versions of this package will be deprecated**. We recommend upgrading to version `4.0.0` as soon as possible before **February 1st, 2025.** + ## Usage This package is used by the v2+ versions of our first party cache action. You can find an example implementation in the cache repo [here](https://github.com/actions/cache). @@ -47,5 +53,3 @@ const cacheKey = await cache.restoreCache(paths, key, restoreKeys) A cache gets downloaded in multiple segments of fixed sizes (now `128MB` to fail-fast, previously `1GB` for a `32-bit` runner and `2GB` for a `64-bit` runner were used). Sometimes, a segment download gets stuck which causes the workflow job to be stuck forever and fail. Version `v3.0.4` of cache package introduces a segment download timeout. The segment download timeout will allow the segment download to get aborted and hence allow the job to proceed with a cache miss. Default value of this timeout is 10 minutes (starting `v3.2.1` and higher, previously 60 minutes in versions between `v.3.0.4` and `v3.2.0`, both included) and can be customized by specifying an [environment variable](https://docs.github.com/en/actions/learn-github-actions/environment-variables) named `SEGMENT_DOWNLOAD_TIMEOUT_MINS` with timeout value in minutes. - - diff --git a/packages/cache/RELEASES.md b/packages/cache/RELEASES.md index ebe6f031..02be2ac0 100644 --- a/packages/cache/RELEASES.md +++ b/packages/cache/RELEASES.md @@ -5,8 +5,8 @@ #### Important changes - The cache backend service has been rewritten from the ground up for improved performance and reliability. This release integrates with the new cache service (v2) APIs. The new service will gradually rollout following the deprecation period. The legacy service will be sunset on **February 1st, 2025**. -- Changes in this release are **fully backward compatible**. Upgrading to this version should not break or require any changes to your workflows beyond updating your `package.json` to this version. -- **All previous versions of this package will be deprecated**. We recommend upgrading to this version as soon as possible before **February 1st, 2025.** +- Changes in this release are **fully backward compatible**. Upgrading to version `4.0.0` should not break or require any changes to your workflows beyond updating your `package.json` to this version. +- **All previous versions of this package will be deprecated**. We recommend upgrading to version `4.0.0` as soon as possible before **February 1st, 2025.** #### Minor changes From 59845ec3725df5c79d93c4ffd8e3d26d2ac83319 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Wed, 4 Dec 2024 05:30:50 -0800 Subject: [PATCH 3/6] Update deprecation notice --- packages/cache/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 2f7be8df..558999ac 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -6,11 +6,17 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac Note that GitHub will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 10 GB. If you exceed this limit, GitHub will save your cache but will begin evicting caches until the total size is less than 10 GB. -## Important changes +## ⚠️ Important changes -- The cache backend service has been rewritten from the ground up for improved performance and reliability. This release integrates with the new cache service (v2) APIs. The new service will gradually rollout following the deprecation period. The legacy service will be sunset on **February 1st, 2025**. -- Changes in the `4.0.0` release are **fully backward compatible**. Upgrading to version `4.0.0` should not break or require any changes to your workflows beyond updating your `package.json` to this version. -- **All previous versions of this package will be deprecated**. We recommend upgrading to version `4.0.0` as soon as possible before **February 1st, 2025.** +The cache backend service has been rewritten from the ground up for improved performance and reliability. The [@actions/cache](https://github.com/actions/toolkit/tree/main/packages/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` as soon as possible before **February 1st, 2025.** + +If you do not upgrade, all workflow runs using any of the deprecated [@actions/cache](https://github.com/actions/toolkit/tree/main/packages/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`. ## Usage From 72447df44c8dd2e0969cde019dc956addeb1598a Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Wed, 4 Dec 2024 05:33:47 -0800 Subject: [PATCH 4/6] Update deprecation notice --- packages/cache/README.md | 2 ++ packages/cache/RELEASES.md | 14 +++++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 558999ac..92820f7c 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -18,6 +18,8 @@ If you do not upgrade, all workflow runs using any of the deprecated [@actions/c 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`. +Read more about change & access the migration guide: [reference to the announcement](TBD). + ## Usage This package is used by the v2+ versions of our first party cache action. You can find an example implementation in the cache repo [here](https://github.com/actions/cache). diff --git a/packages/cache/RELEASES.md b/packages/cache/RELEASES.md index 02be2ac0..552abc97 100644 --- a/packages/cache/RELEASES.md +++ b/packages/cache/RELEASES.md @@ -4,9 +4,17 @@ #### Important changes -- The cache backend service has been rewritten from the ground up for improved performance and reliability. This release integrates with the new cache service (v2) APIs. The new service will gradually rollout following the deprecation period. The legacy service will be sunset on **February 1st, 2025**. -- Changes in this release are **fully backward compatible**. Upgrading to version `4.0.0` should not break or require any changes to your workflows beyond updating your `package.json` to this version. -- **All previous versions of this package will be deprecated**. We recommend upgrading to version `4.0.0` as soon as possible before **February 1st, 2025.** +The cache backend service has been rewritten from the ground up for improved performance and reliability. The [@actions/cache](https://github.com/actions/toolkit/tree/main/packages/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` as soon as possible before **February 1st, 2025.** + +If you do not upgrade, all workflow runs using any of the deprecated [@actions/cache](https://github.com/actions/toolkit/tree/main/packages/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`. + +Read more about change & access the migration guide: [reference to the announcement](TBD). #### Minor changes From cd9197e9bdaef000bdc0a4e3269169a90c6d4554 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Wed, 4 Dec 2024 08:23:10 -0800 Subject: [PATCH 5/6] Add announcement link --- packages/cache/README.md | 2 +- packages/cache/RELEASES.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index 92820f7c..0f743848 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -18,7 +18,7 @@ If you do not upgrade, all workflow runs using any of the deprecated [@actions/c 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`. -Read more about change & access the migration guide: [reference to the announcement](TBD). +Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/toolkit/discussions/1890). ## Usage diff --git a/packages/cache/RELEASES.md b/packages/cache/RELEASES.md index 552abc97..8355e977 100644 --- a/packages/cache/RELEASES.md +++ b/packages/cache/RELEASES.md @@ -14,7 +14,7 @@ If you do not upgrade, all workflow runs using any of the deprecated [@actions/c 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`. -Read more about change & access the migration guide: [reference to the announcement](TBD). +Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/toolkit/discussions/1890). #### Minor changes