feat: cache-update: [true|false] option (#1)

.github/workflows/rust.yml

@@ -21,8 +21,8 @@ jobs:
       - uses: ./
         with:
           release-name: v0.3.0
-          cache-key: ${{ runner.os }}-sccache
-          cache-suffix: ${{ github.event_name != 'pull_request' }}
+          cache-key: ${{ runner.os }}-sccache-v1.2
+          cache-update: ${{ github.event_name != 'pull_request' }}
       - run: sccache -s
       - run: cargo build -v
         env:

README.md

@@ -11,10 +11,10 @@ This repository provides GitHub Actions which enables projects to cache the comp
   with:
     # Optional
     cache-key: sccache-ubuntu-latest
-    # Optional
+    # Optional, whether or not saving the cache
     cache-save: true
-    # Optional
-    cache-suffix: true
+    # Optional whether or not updating cache when hit
+    cache-update: true
     # Optional,  e.g. v0.3.0
     release-name: latest
     # Optional

action.yml

@@ -7,8 +7,8 @@ inputs:
   cache-save:
     description: "A Flag that indicates whether or not saving the cache"
     default: true
-  cache-suffix:
-    description: "A Flag that indicates whether or not appending timestamp suffix to the cache key when saving"
+  cache-update:
+    description: "A Flag that indicates whether or not updating cache when hit"
     default: true
   release-name:
     description: "The sccache version. e.g. v0.3.0"

src/constants.ts

@@ -0,0 +1,3 @@
+export enum State {
+    RestoredCacheKey = "RESTORED_CACHE_KEY",
+} 

src/main.ts

@@ -4,6 +4,7 @@ import { Octokit } from "@octokit/rest";
 import * as core from '@actions/core';
 import * as cache from '@actions/cache';
 import { exec } from '@actions/exec';
+import { State } from './constants';
 
 function sleep(ms: number) {
 	return new Promise(resolve => setTimeout(resolve, ms));
@@ -77,6 +78,7 @@ export const restoreCache = async (restoreKey: string) => {
 		[`${process.env.HOME}/.cache/sccache`, `${process.env.HOME}/Library/Caches/Mozilla.sccache`], restoreKey, [`${restoreKey}-`]);
 	if (restoredCacheKey) {
 		core.info(`Cache restored from ${restoredCacheKey}.`);
+		core.saveState(State.RestoredCacheKey, restoredCacheKey);
 	} else {
 		core.info("Cache not found.");
 	}

src/post.ts

@@ -2,21 +2,32 @@
 import * as core from '@actions/core';
 import * as cache from '@actions/cache';
 import { exec } from '@actions/exec';
+import { State } from './constants';
 
 export const showStat = async () => {
 	await exec("sccache -s");
 };
 
 export const saveCache = async () => {
 	try {
-		const shouldSaveCache = core.getBooleanInput('cache-save');
+		let shouldSaveCache = core.getBooleanInput('cache-save');
 		if (!shouldSaveCache) {
 			console.log(`Aborting, shouldSaveCache: ${shouldSaveCache}`);
 			return;
 		}
-		const shouldAppendSuffix = core.getBooleanInput('cache-suffix');
-		console.log(`shouldAppendSuffix: ${shouldAppendSuffix}`);
-		const cacheKey = shouldAppendSuffix ? `${core.getInput('cache-key')}-${new Date().toISOString()}` : core.getInput('cache-key');
+		let shouldUpdateCache = core.getBooleanInput('cache-update');
+		if (!shouldUpdateCache) {
+			const cacheKey = core.getState(State.RestoredCacheKey);
+			console.log(`cacheKey: ${cacheKey}`);
+			if (!cacheKey) {
+				shouldUpdateCache = true;
+			}
+		}
+		if (!shouldUpdateCache) {
+			console.log(`Aborting, shouldUpdateCache: ${shouldUpdateCache}`);
+			return;
+		}
+		const cacheKey = `${core.getInput('cache-key')}-${new Date().toISOString()}`;
 		console.log(`Using cacheKey: ${cacheKey}`);
 		await cache.saveCache([`${process.env.HOME}/.cache/sccache`, `${process.env.HOME}/Library/Caches/Mozilla.sccache`], cacheKey);
 	} catch (err: any) {