Add an option to disable dependency caching on demand (#34)

fixes #24

.github/workflows/ci.yml

@@ -94,6 +94,11 @@ jobs:
         with:
           scarb-lock: ./subdir/Scarb.lock
 
+      - name: "Setup Scarb with caching disabled"
+        uses: ./
+        with:
+          cache: false
+
       - name: "Create .tool-versions file"
         run: echo "scarb 0.7.0" >> .tool-versions
       - name: "Setup Scarb using `.tool-versions` file"

README.md

@@ -36,6 +36,9 @@ jobs:
 - `scarb-lock` - **Optional**. String.
   - Stating a relative or absolute path to the `Scarb.lock` file used for caching dependencies.
   - Empty/not specified: `Scarb.lock` in the working directory will be used.
+- `cache` - **Optional**. Boolean.
+  - Enables caching Scarb dependencies.
+  - Empty/not specified: `true`.
 
 ## Outputs
 

action.yml

@@ -14,6 +14,10 @@ inputs:
   scarb-lock:
     description: Path to Scarb.lock file
     required: false
+  cache:
+    description: Enable dependency caching
+    required: false
+    default: "true"
 outputs:
   scarb-prefix:
     description: The prefix of the installed Scarb

dist/cache-save/index.js

@@ -73723,6 +73723,13 @@ async function getScarbLockPath(scarbLockPath) {
 
 
 async function saveCache() {
+  const enableCache = core.getBooleanInput("cache");
+
+  if (!enableCache) {
+    core.info(`Caching disabled, not saving cache.`);
+    return;
+  }
+
   try {
     const primaryKey = core.getState(State.CachePrimaryKey);
     const matchedKey = core.getState(State.CacheMatchedKey);

dist/setup/index.js

@@ -74854,6 +74854,7 @@ async function main() {
     const scarbVersionInput = core.getInput("scarb-version");
     const toolVersionsPathInput = core.getInput("tool-versions");
     const scarbLockPathInput = core.getInput("scarb-lock");
+    const enableCache = core.getBooleanInput("cache");
 
     const { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
@@ -74887,13 +74888,17 @@ async function main() {
 
     core.setOutput("scarb-version", await getFullVersionFromScarb());
 
-    await restoreCache(scarbLockPathInput).catch((e) => {
-      core.error(
-        `There was an error when restoring cache: ${
-          e instanceof Error ? e.message : e
-        }`,
-      );
-    });
+    if (enableCache) {
+      await restoreCache(scarbLockPathInput).catch((e) => {
+        core.error(
+          `There was an error when restoring cache: ${
+            e instanceof Error ? e.message : e
+          }`,
+        );
+      });
+    } else {
+      core.info(`Caching disabled, not restoring cache.`);
+    }
   } catch (e) {
     core.setFailed(e);
   }

lib/cache-save.js

@@ -4,6 +4,13 @@ import * as cache from "@actions/cache";
 import { getCacheDirectory, State } from "./cache-utils";
 
 async function saveCache() {
+  const enableCache = core.getBooleanInput("cache");
+
+  if (!enableCache) {
+    core.info(`Caching disabled, not saving cache.`);
+    return;
+  }
+
   try {
     const primaryKey = core.getState(State.CachePrimaryKey);
     const matchedKey = core.getState(State.CacheMatchedKey);

lib/main.js

@@ -15,6 +15,7 @@ export default async function main() {
     const scarbVersionInput = core.getInput("scarb-version");
     const toolVersionsPathInput = core.getInput("tool-versions");
     const scarbLockPathInput = core.getInput("scarb-lock");
+    const enableCache = core.getBooleanInput("cache");
 
     const { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
@@ -48,13 +49,17 @@ export default async function main() {
 
     core.setOutput("scarb-version", await getFullVersionFromScarb());
 
-    await restoreCache(scarbLockPathInput).catch((e) => {
-      core.error(
-        `There was an error when restoring cache: ${
-          e instanceof Error ? e.message : e
-        }`,
-      );
-    });
+    if (enableCache) {
+      await restoreCache(scarbLockPathInput).catch((e) => {
+        core.error(
+          `There was an error when restoring cache: ${
+            e instanceof Error ? e.message : e
+          }`,
+        );
+      });
+    } else {
+      core.info(`Caching disabled, not restoring cache.`);
+    }
   } catch (e) {
     core.setFailed(e);
   }