diff --git a/README.md b/README.md index 9da9474..84d6bd0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ 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 diff --git a/action.yml b/action.yml index 14f247f..09d1665 100644 --- a/action.yml +++ b/action.yml @@ -29,7 +29,11 @@ inputs: save-always: description: 'Run the post step to save the cache even if another step before fails' default: 'false' - required: 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 outputs: cache-hit: description: 'A boolean value to indicate an exact match was found for the primary key' diff --git a/save/action.yml b/save/action.yml index 6696d45..2ab5387 100644 --- a/save/action.yml +++ b/save/action.yml @@ -15,6 +15,10 @@ 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' diff --git a/src/constants.ts b/src/constants.ts index 0158ae0..4d90a66 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -5,7 +5,8 @@ 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 + LookupOnly = "lookup-only", // Input for cache, restore action + ForceOverwrite = "force-overwrite" // Input for cache action } export enum Outputs { diff --git a/src/saveImpl.ts b/src/saveImpl.ts index 4e5c312..8291bc2 100644 --- a/src/saveImpl.ts +++ b/src/saveImpl.ts @@ -47,13 +47,21 @@ export async function saveImpl( // NO-OP in case of SaveOnly action const restoredKey = stateProvider.getCacheState(); - if (utils.isExactKeyMatch(primaryKey, restoredKey)) { + const forceOverwrite = utils.getInputAsBool(Inputs.ForceOverwrite); + if (utils.isExactKeyMatch(primaryKey, restoredKey) && !forceOverwrite) { core.info( - `Cache hit occurred on the primary key ${primaryKey}, not saving cache.` + `Cache hit occurred on the primary key "${primaryKey}" and force-overwrite is disabled, 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 });