feat: Introduced `post` flag on `actions/cache/save`

__tests__/saveOnly.test.ts

@@ -10,6 +10,11 @@ jest.unstable_mockModule("@actions/core", () => ({
         }
         return val.trim();
     }),
+    getBooleanInput: jest.fn(
+        (name: string, options?: { required?: boolean }) => {
+            return core.getInput(name, options).toLowerCase() === "true";
+        }
+    ),
     setOutput: jest.fn(),
     setFailed: jest.fn(),
     info: jest.fn(),
@@ -129,3 +134,39 @@ test("save failing logs the debug message", async () => {
     expect(warningMock).not.toHaveBeenCalled();
     expect(failedMock).not.toHaveBeenCalled();
 });
+
+test.each([
+    [true, false],
+    [true, true],
+    [false, true],
+    [false, false]
+])("save honors post behavior", async (postInput, postMode) => {
+    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
+
+    const inputPath = "node_modules";
+    testUtils.setInput(Inputs.Key, primaryKey);
+    testUtils.setInput(Inputs.Path, inputPath);
+    testUtils.setInput(Inputs.Post, `${postInput}`);
+
+    const cacheId = 4;
+    (cache.saveCache as jest.Mock).mockResolvedValue(cacheId);
+
+    await saveOnlyRun(undefined, postMode);
+
+    if (postInput === postMode) {
+        // expects cache to run
+        expect(cache.saveCache).toHaveBeenCalledTimes(1);
+        expect(cache.saveCache).toHaveBeenCalledWith(
+            [inputPath],
+            primaryKey,
+            {},
+            false
+        );
+
+        expect(core.setFailed).toHaveBeenCalledTimes(0);
+    } else {
+        // expect to be no-op
+        expect(cache.saveCache).not.toHaveBeenCalled();
+        expect(core.setFailed).not.toHaveBeenCalled();
+    }
+});

dist/restore-only/index.js

@@ -94887,7 +94887,8 @@ var Inputs;
     Inputs["UploadChunkSize"] = "upload-chunk-size";
     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive";
     Inputs["FailOnCacheMiss"] = "fail-on-cache-miss";
-    Inputs["LookupOnly"] = "lookup-only"; // Input for cache, restore action
+    Inputs["LookupOnly"] = "lookup-only";
+    Inputs["Post"] = "post"; // Input for save action
 })(Inputs || (Inputs = {}));
 var Outputs;
 (function (Outputs) {

dist/restore/index.js

@@ -94887,7 +94887,8 @@ var Inputs;
     Inputs["UploadChunkSize"] = "upload-chunk-size";
     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive";
     Inputs["FailOnCacheMiss"] = "fail-on-cache-miss";
-    Inputs["LookupOnly"] = "lookup-only"; // Input for cache, restore action
+    Inputs["LookupOnly"] = "lookup-only";
+    Inputs["Post"] = "post"; // Input for save action
 })(Inputs || (Inputs = {}));
 var constants_Outputs;
 (function (Outputs) {

dist/save-only/index.js

@@ -94892,7 +94892,8 @@ var Inputs;
     Inputs["UploadChunkSize"] = "upload-chunk-size";
     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive";
     Inputs["FailOnCacheMiss"] = "fail-on-cache-miss";
-    Inputs["LookupOnly"] = "lookup-only"; // Input for cache, restore action
+    Inputs["LookupOnly"] = "lookup-only";
+    Inputs["Post"] = "post"; // Input for save action
 })(Inputs || (Inputs = {}));
 var Outputs;
 (function (Outputs) {
@@ -95052,7 +95053,11 @@ async function saveImpl(stateProvider) {
     }
     return cacheId;
 }
-async function saveOnlyRun(earlyExit) {
+async function saveOnlyRun(earlyExit, postStep) {
+    if (postStep !== undefined &&
+        postStep !== getInputAsBool(Inputs.Post)) {
+        return;
+    }
     try {
         const cacheId = await saveImpl(new NullStateProvider());
         if (cacheId === -1) {
@@ -95100,5 +95105,5 @@ async function saveRun(earlyExit) {
 
 ;// CONCATENATED MODULE: ./src/saveOnly.ts
 
-saveOnlyRun(true);
+saveOnlyRun(true, false);
 

dist/save-only/post/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

dist/save/index.js

@@ -94884,7 +94884,7 @@ function saveCacheV2(paths_1, key_1, options_1) {
 }
 //# sourceMappingURL=cache.js.map
 ;// CONCATENATED MODULE: ./src/constants.ts
-var Inputs;
+var constants_Inputs;
 (function (Inputs) {
     Inputs["Key"] = "key";
     Inputs["Path"] = "path";
@@ -94892,8 +94892,9 @@ var Inputs;
     Inputs["UploadChunkSize"] = "upload-chunk-size";
     Inputs["EnableCrossOsArchive"] = "enableCrossOsArchive";
     Inputs["FailOnCacheMiss"] = "fail-on-cache-miss";
-    Inputs["LookupOnly"] = "lookup-only"; // Input for cache, restore action
+    Inputs["LookupOnly"] = "lookup-only";
-})(Inputs || (Inputs = {}));
+    Inputs["Post"] = "post"; // Input for save action
+})(constants_Inputs || (constants_Inputs = {}));
 var constants_Outputs;
 (function (Outputs) {
     Outputs["CacheHit"] = "cache-hit";
@@ -95026,7 +95027,7 @@ async function saveImpl(stateProvider) {
         // If restore has stored a primary key in state, reuse that
         // Else re-evaluate from inputs
         const primaryKey = stateProvider.getState(constants_State.CachePrimaryKey) ||
-            getInput(Inputs.Key);
+            getInput(constants_Inputs.Key);
         if (!primaryKey) {
             logWarning(`Key is not specified.`);
             return;
@@ -95038,11 +95039,11 @@ async function saveImpl(stateProvider) {
             info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
             return;
         }
-        const cachePaths = getInputAsArray(Inputs.Path, {
+        const cachePaths = getInputAsArray(constants_Inputs.Path, {
             required: true
         });
-        const enableCrossOsArchive = getInputAsBool(Inputs.EnableCrossOsArchive);
+        const enableCrossOsArchive = getInputAsBool(constants_Inputs.EnableCrossOsArchive);
-        cacheId = await cache_saveCache(cachePaths, primaryKey, { uploadChunkSize: getInputAsInt(Inputs.UploadChunkSize) }, enableCrossOsArchive);
+        cacheId = await cache_saveCache(cachePaths, primaryKey, { uploadChunkSize: getInputAsInt(constants_Inputs.UploadChunkSize) }, enableCrossOsArchive);
         if (cacheId != -1) {
             info(`Cache saved with key: ${primaryKey}`);
         }
@@ -95052,7 +95053,11 @@ async function saveImpl(stateProvider) {
     }
     return cacheId;
 }
-async function saveOnlyRun(earlyExit) {
+async function saveOnlyRun(earlyExit, postStep) {
+    if (postStep !== undefined &&
+        postStep !== utils.getInputAsBool(Inputs.Post)) {
+        return;
+    }
     try {
         const cacheId = await saveImpl(new NullStateProvider());
         if (cacheId === -1) {

package.json

@@ -6,7 +6,7 @@
   "type": "module",
   "main": "dist/restore/index.js",
   "scripts": {
-    "build": "tsc && ncc build -o dist/restore src/restore.ts && ncc build -o dist/save src/save.ts && ncc build -o dist/restore-only src/restoreOnly.ts && ncc build -o dist/save-only src/saveOnly.ts",
+    "build": "tsc && ncc build -o dist/restore src/restore.ts && ncc build -o dist/save src/save.ts && ncc build -o dist/restore-only src/restoreOnly.ts && ncc build -o dist/save-only src/saveOnly.ts && ncc build -o dist/save-only/post src/saveOnlyPost.ts",
     "test": "tsc --noEmit && node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
     "lint": "eslint **/*.ts --cache",
     "format": "prettier --write **/*.ts",

save/README.md

@@ -9,6 +9,7 @@ The save action saves a cache. It works similarly to the `cache` action except t
 * `key` - An explicit key for a cache entry. See [creating a cache key](../README.md#creating-a-cache-key).
 * `path` - A list of files, directories, and wildcard patterns to cache. See [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns.
 * `upload-chunk-size` - The chunk size used to split up large files during upload, in bytes
+* `post` - If set to `true` the action will run as a post-step, after the job has finished.
 
 ### Outputs
 

save/action.yml

@@ -15,9 +15,15 @@ inputs:
     description: 'An optional boolean when enabled, allows windows runners to save caches that can be restored on other platforms'
     default: 'false'
     required: false
+  post:
+    description: 'An optional boolean when enabled, allows the action to run after the job has completed'
+    default: 'false'
+    required: false
 runs:
   using: 'node24'
   main: '../dist/save-only/index.js'
+  post: '../dist/save-only/post/index.js'
+  post-if: "success()"
 branding:
   icon: 'archive'
   color: 'gray-dark'

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
+    Post = "post" // Input for save action
 }
 
 export enum Outputs {

src/saveImpl.ts

@@ -79,8 +79,16 @@ export async function saveImpl(
 }
 
 export async function saveOnlyRun(
-    earlyExit?: boolean | undefined
+    earlyExit?: boolean | undefined,
+    postStep?: boolean | undefined
 ): Promise<void> {
+    if (
+        postStep !== undefined &&
+        postStep !== utils.getInputAsBool(Inputs.Post)
+    ) {
+        return;
+    }
+
     try {
         const cacheId = await saveImpl(new NullStateProvider());
         if (cacheId === -1) {

src/saveOnly.ts

@@ -1,3 +1,3 @@
 import { saveOnlyRun } from "./saveImpl";
 
-saveOnlyRun(true);
+saveOnlyRun(true, false);

src/saveOnlyPost.ts

@@ -0,0 +1,3 @@
+import { saveOnlyRun } from "./saveImpl";
+
+saveOnlyRun(true, true);