Add an option to disable dependency caching on demand

fixes #24

Author: mkaput

.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,9 @@ inputs:
   scarb-lock:
     description: Path to Scarb.lock file
     required: false
+  cache:
+    description: Enable dependency caching
+    required: false
 outputs:
   scarb-prefix:
     description: The prefix of the installed Scarb

lib/cache-save.js

@@ -1,9 +1,16 @@
 import * as core from "@actions/core";
 import * as cache from "@actions/cache";
 
-import { getCacheDirectory, State } from "./cache-utils";
+import { getCacheDirectory, isCacheEnabled, State } from "./cache-utils";
 
 async function saveCache() {
+  const cacheInput = core.getInput("cache");
+
+  if (!isCacheEnabled(cacheInput)) {
+    core.info(`Caching disabled, not saving cache.`);
+    return;
+  }
+
   try {
     const primaryKey = core.getState(State.CachePrimaryKey);
     const matchedKey = core.getState(State.CacheMatchedKey);

lib/cache-utils.js

@@ -11,6 +11,11 @@ export const State = {
   CacheMatchedKey: "matched_key",
 };
 
+export function isCacheEnabled(cacheInput) {
+  cacheInput = cacheInput || "true";
+  return cacheInput === "true";
+}
+
 export async function getCacheDirectory() {
   // NOTE: The `cache path` command was introduced in Scarb 0.7.0. We do not want to break compatibility with older
   //   versions yet, so we fall back to a well-known cache path if this command is not available.

lib/main.js

@@ -9,12 +9,14 @@ import {
 import { downloadScarb } from "./download";
 import { getOsTriplet } from "./platform";
 import { restoreCache } from "./cache-restore";
+import { isCacheEnabled } from "./cache-utils";
 
 export default async function main() {
   try {
     const scarbVersionInput = core.getInput("scarb-version");
     const toolVersionsPathInput = core.getInput("tool-versions");
     const scarbLockPathInput = core.getInput("scarb-lock");
+    const cacheInput = core.getInput("cache");
 
     const { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
@@ -48,13 +50,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 (isCacheEnabled(cacheInput)) {
+      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);
   }