Merge branch 'main' into dependabot/npm_and_yarn/eslint-plugin-import-2.31.0

Bumps [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) from 2.26.0 to 2.31.0.
- [Release notes](https://github.com/import-js/eslint-plugin-import/releases)
- [Changelog](https://github.com/import-js/eslint-plugin-import/blob/main/CHANGELOG.md)
- [Commits](https://github.com/import-js/eslint-plugin-import/compare/v2.26.0...v2.31.0)

---
updated-dependencies:
- dependency-name: eslint-plugin-import
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/workflows/publish-immutable-actions.yml

@@ -2,7 +2,7 @@ name: 'Publish Immutable Action Version'
 
 on:
   release:
-    types: [released]
+    types: [published]
 
 jobs:
   publish:

.github/workflows/workflow.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Setup Node.js 20.x
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v3
       with:
         node-version: 20.x
         cache: npm

.licensed.yml

@@ -13,10 +13,4 @@ allowed:
 
 reviewed:
   npm:
-  - sax
+  - sax
-  - "@protobuf-ts/plugin-framework" # Apache-2.0
-  - "@protobuf-ts/runtime" # Apache-2.0
-  - fs.realpath # ISC
-  - glob # ISC
-  - prettier # MIT
-  - lodash # MIT

README.md

@@ -3,7 +3,6 @@
 This action allows caching dependencies and build outputs to improve workflow execution time.
 
 >Two other actions are available in addition to the primary `cache` action:
->
 >* [Restore action](./restore/README.md)
 >* [Save action](./save/README.md)
 
@@ -15,30 +14,12 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac
 
 ## What's New
 
-### ⚠️ Important changes
-
-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**.
-
-**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 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.
-
-Read more about the change & access the migration guide: [reference to the announcement](https://github.com/actions/cache/discussions/1510).
-
 ### v4
 
-* Integrated with the new cache service (v2) APIs.
 * Updated to node 20
 
 ### v3
 
-* Integrated with the new cache service (v2) APIs.
 * Added support for caching in GHES 3.5+.
 * Fixed download issue for files > 2GB during restore.
 * Updated the minimum runner version support from node 12 -> node 16.

RELEASES.md

@@ -1,38 +1,9 @@
 # Releases
 
-### 4.2.2
-
-- Bump `@actions/cache` to v4.0.2
-
-### 4.2.1
-
-- Bump `@actions/cache` to v4.0.1
-
-### 4.2.0
-
-TLDR; 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**.
-
-**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 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.
-
-### 4.1.2
-
-- Add GitHub Enterprise Cloud instances hostname filters to inform API endpoint choices - [#1474](https://github.com/actions/cache/pull/1474)
-- Security fix: Bump braces from 3.0.2 to 3.0.3 - [#1475](https://github.com/actions/cache/pull/1475)
-
 ### 4.1.1
-
 - Restore original behavior of `cache-hit` output - [#1467](https://github.com/actions/cache/pull/1467)
 
 ### 4.1.0
-
 - Ensure `cache-hit` output is set when a cache is missed - [#1404](https://github.com/actions/cache/pull/1404)
 - Deprecate `save-always` input - [#1452](https://github.com/actions/cache/pull/1452)
 
@@ -48,10 +19,6 @@ Upgrading to the recommended versions will not break your workflows.
 
 - Updated minimum runner version support from node 12 -> node 20
 
-### 3.4.0
-
-- Integrated with the new cache service (v2) APIs
-
 ### 3.3.3
 
 - Updates @actions/cache to v3.2.3 to fix accidental mutated path arguments to `getCacheVersion` [actions/toolkit#1378](https://github.com/actions/toolkit/pull/1378)

caching-strategies.md

@@ -102,7 +102,7 @@ The [GitHub Context](https://docs.github.com/en/actions/learn-github-actions/con
 
 While setting paths for caching dependencies it is important to give correct path depending on the hosted runner you are using or whether the action is running in a container job. Assigning different `path` for save and restore will result in cache miss.
 
-Below are GitHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
+Below are GiHub hosted runner specific paths one should take care of when writing a workflow which saves/restores caches across OS.
 
 #### Ubuntu Paths
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "4.2.2",
+  "version": "4.1.1",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
@@ -23,10 +23,10 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^4.0.2",
+    "@actions/cache": "^3.2.3",
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
-    "@actions/io": "^1.1.3"
+    "@actions/io": "^1.1.2"
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",
@@ -34,10 +34,10 @@
     "@types/node": "^16.18.3",
     "@typescript-eslint/eslint-plugin": "^5.45.0",
     "@typescript-eslint/parser": "^5.45.0",
-    "@vercel/ncc": "^0.38.3",
+    "@vercel/ncc": "^0.38.1",
     "eslint": "^8.28.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^26.9.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^7.0.0",

save/README.md

@@ -79,10 +79,8 @@ To avoid saving a cache that already exists, the `cache-hit` output from a resto
 The `cache-primary-key` output from the restore step should also be used to ensure
 the cache key does not change during the build if it's calculated based on file contents.
 
-Here's an example where we imagine we're calculating a lot of prime numbers and want to cache them:
-
 ```yaml
-name: Always Caching Prime Numbers
+name: Always Caching Primes
 
 on: push
 
@@ -93,23 +91,23 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Restore cached Prime Numbers
+    - name: Restore cached Primes
-      id: cache-prime-numbers-restore
+      id: cache-primes-restore
       uses: actions/cache/restore@v4
       with:
-        key: ${{ runner.os }}-prime-numbers
+        key: ${{ runner.os }}-primes
         path: |
           path/to/dependencies
           some/other/dependencies
 
     # Intermediate workflow steps
 
-    - name: Always Save Prime Numbers
+    - name: Always Save Primes
-      id: cache-prime-numbers-save
+      id: cache-primes-save
-      if: always() && steps.cache-prime-numbers-restore.outputs.cache-hit != 'true'
+      if: always() && steps.cache-primes-restore.outputs.cache-hit != 'true'
       uses: actions/cache/save@v4
       with:
-        key: ${{ steps.cache-prime-numbers-restore.outputs.cache-primary-key }}
+        key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}
         path: |
           path/to/dependencies
           some/other/dependencies

tips-and-workarounds.md

@@ -37,8 +37,9 @@ From `v3.2.3` cache is cross-os compatible when `enableCrossOsArchive` input is
 
 ## Force deletion of caches overriding default cache eviction policy
 
-Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing.
+Caches have [branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) in place. This means that if caches for a specific branch are using a lot of storage quota, it may result into more frequently used caches from `default` branch getting thrashed. For example, if there are many pull requests happening on a repo and are creating caches, these cannot be used in default branch scope but will still occupy a lot of space till they get cleaned up by [eviction policy](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy). But sometime we want to clean them up on a faster cadence so as to ensure default branch is not thrashing. In order to achieve this, [gh-actions-cache cli](https://github.com/actions/gh-actions-cache/) can be used to delete caches for specific branches.
 
+This workflow uses `gh-actions-cache` to delete all the caches created by a branch.
 <details>
   <summary>Example</summary>
 
@@ -59,23 +60,29 @@ jobs:
       actions: write
       contents: read
     steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
       - name: Cleanup
         run: |
-          echo "Fetching list of cache key"
+          gh extension install actions/gh-actions-cache
-          cacheKeysForPR=$(gh cache list --ref $BRANCH --limit 100 --json id --jq '.[].id')
+          
+          REPO=${{ github.repository }}
+          BRANCH=refs/pull/${{ github.event.pull_request.number }}/merge
 
-          ## Setting this to not fail the workflow while deleting cache keys.
+          echo "Fetching list of cache key"
+          cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
+
+          ## Setting this to not fail the workflow while deleting cache keys. 
           set +e
           echo "Deleting caches..."
           for cacheKey in $cacheKeysForPR
           do
-              gh cache delete $cacheKey
+              gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
           done
           echo "Done"
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GH_REPO: ${{ github.repository }}
-          BRANCH: refs/pull/${{ github.event.pull_request.number }}/merge
 ```
 
 </details>