Add backend ids

README.md

@@ -14,10 +14,6 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac
 
 ## What's New
 
-### Unreleased
-
-* Added the `force-overwrite` flag to force overwrite any existing cache for incremental caching
-
 ### v4
 
 * Updated to node 20
@@ -95,7 +91,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v3
 
     - name: Cache Primes
       id: cache-primes
@@ -126,7 +122,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v3
 
     - name: Restore cached Primes
       id: cache-primes-restore
@@ -233,7 +229,7 @@ Example:
 
 ```yaml
 steps:
-  - uses: actions/checkout@v4
+  - uses: actions/checkout@v3
 
   - uses: actions/cache@v4
     id: cache
@@ -263,7 +259,7 @@ jobs:
   build-linux:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: Cache Primes
         id: cache-primes
@@ -290,7 +286,7 @@ jobs:
   build-windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
 
       - name: Cache Primes
         id: cache-primes

__tests__/restore.test.ts

@@ -260,7 +260,7 @@ test("Fail restore when fail on cache miss is enabled and primary + restore keys
     );
 
     expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
-    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
+    expect(setCacheHitOutputMock).toHaveBeenCalledTimes(0);
 
     expect(failedMock).toHaveBeenCalledWith(
         `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${key}`

__tests__/restoreOnly.test.ts

@@ -86,8 +86,7 @@ test("restore with no cache found", async () => {
     );
 
     expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
-    expect(outputMock).toHaveBeenCalledWith("cache-hit", "false");
-    expect(outputMock).toHaveBeenCalledTimes(2);
+    expect(outputMock).toHaveBeenCalledTimes(1);
     expect(failedMock).toHaveBeenCalledTimes(0);
 
     expect(infoMock).toHaveBeenCalledWith(

action.yml

@@ -29,11 +29,7 @@ inputs:
   save-always:
     description: 'Run the post step to save the cache even if another step before fails'
     default: 'false'
-    required: false
-  force-overwrite:
-    description: 'Delete any previous (incremental) cache before pushing a new cache even if a cache for the primary cache key exists'
-    default: 'false'
-    required: false
+    required: false    
 outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'

examples.md

@@ -513,7 +513,6 @@ jobs:
 ```yaml
 - name: Get pip cache dir
   id: pip-cache
-  shell: bash
   run: |
     echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 

package.json

@@ -23,10 +23,10 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.3",
-    "@actions/core": "^1.10.0",
-    "@actions/exec": "^1.1.1",
-    "@actions/io": "^1.1.2"
+    "@actions/cache": "file:/workspaces/toolkit/packages/cache",
+    "@actions/core": "file:/workspaces/toolkit/packages/core",
+    "@actions/exec": "file:/workspaces/toolkit/packages/exec",
+    "@actions/io": "file:/workspaces/toolkit/packages/io"
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",

save/action.yml

@@ -15,10 +15,6 @@ inputs:
     description: 'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms'
     default: 'false'
     required: false
-  force-overwrite:
-    description: 'Delete any previous (incremental) cache before pushing a new cache even if a cache for the primary cache key exists'
-    default: 'false'
-    required: false
 runs:
   using: 'node20'
   main: '../dist/save-only/index.js'

src/constants.ts

@@ -5,8 +5,7 @@ export enum Inputs {
     UploadChunkSize = "upload-chunk-size", // Input for cache, save action
     EnableCrossOsArchive = "enableCrossOsArchive", // Input for cache, restore, save action
     FailOnCacheMiss = "fail-on-cache-miss", // Input for cache, restore action
-    LookupOnly = "lookup-only", // Input for cache, restore action
-    ForceOverwrite = "force-overwrite" // Input for cache action
+    LookupOnly = "lookup-only" // Input for cache, restore action
 }
 
 export enum Outputs {

src/restoreImpl.ts

@@ -51,7 +51,6 @@ export async function restoreImpl(
         );
 
         if (!cacheKey) {
-            core.setOutput(Outputs.CacheHit, false.toString());
             if (failOnCacheMiss) {
                 throw new Error(
                     `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${primaryKey}`
@@ -63,6 +62,7 @@ export async function restoreImpl(
                     ...restoreKeys
                 ].join(", ")}`
             );
+
             return;
         }
 

src/saveImpl.ts

@@ -47,21 +47,13 @@ export async function saveImpl(
         // NO-OP in case of SaveOnly action
         const restoredKey = stateProvider.getCacheState();
 
-        const forceOverwrite = utils.getInputAsBool(Inputs.ForceOverwrite);
-        if (utils.isExactKeyMatch(primaryKey, restoredKey) && !forceOverwrite) {
+        if (utils.isExactKeyMatch(primaryKey, restoredKey)) {
             core.info(
-                `Cache hit occurred on the primary key "${primaryKey}" and force-overwrite is disabled, not saving cache.`
+                `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
             );
             return;
         }
 
-        if ((restoredKey == undefined || utils.isExactKeyMatch(primaryKey, restoredKey)) && forceOverwrite) {
-            core.info(
-                `Cache hit occurred on the primary key "${primaryKey}" or running as save-only and force-overwrite is enabled, deleting cache.`
-            );
-            await cache.deleteCache(primaryKey)
-        }
-
         const cachePaths = utils.getInputAsArray(Inputs.Path, {
             required: true
         });