Support specifying custom Scarb.lock path (#27)

- Allow specifying path to `Scarb.lock` via optional `scarb-lock`
argument
- If not specified, default to `Scarb.lock` in cwd for consistency with
`toolVersionsPath`
- Fix caching test steps

Closes #25

Author: DelevoXDG

.github/workflows/ci.yml

@@ -21,15 +21,31 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: "Create bare bones Scarb.toml for cache testing"
+      - name: "Create bare bones Scarb.lock for cache testing"
         shell: bash
         run: |
-          cat <<EOF > Scarb.toml
-          [package]
+          cat <<EOF > Scarb.lock
+          # Code generated by scarb DO NOT EDIT.
+          version = 1
+            
+          [[package]]
           name = "example_package"
           version = "1.0.0"
           EOF
 
+      - name: "Create Scarb.lock in subfolder for cache testing"
+        shell: bash
+        run: |
+          mkdir ./subdir
+          cat <<EOF > ./subdir/Scarb.lock
+          # Code generated by scarb DO NOT EDIT.
+          version = 1
+            
+          [[package]]
+          name = "example_package"
+          version = "1.1.0"
+          EOF
+
       - name: "Fetch latest Scarb version from GitHub releases"
         id: version
         shell: pwsh
@@ -73,6 +89,11 @@ jobs:
           scarb-version: nightly
       - run: scarb --version | grep "${{ steps.version.outputs.LATEST_NIGHTLY_VERSION }}"
 
+      - name: "Setup Scarb with `scarb-lock` file in subfolder"
+        uses: ./
+        with:
+          scarb-lock: ./subdir/Scarb.lock
+
       - name: "Create .tool-versions file"
         run: echo "scarb 0.7.0" >> .tool-versions
       - name: "Setup Scarb using `.tool-versions` file"

README.md

@@ -33,6 +33,9 @@ jobs:
 - `tool-versions` - **Optional**. String.
   - Stating a relative or absolute path to the `.tool-versions` file.
   - Should be used only if `scarb-version` is not specified.
+- `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.
 
 ## Outputs
 

action.yml

@@ -11,6 +11,9 @@ inputs:
   tool-versions:
     description: Path to .tool-versions file
     required: false
+  scarb-lock:
+    description: Path to Scarb.lock file
+    required: false
 outputs:
   scarb-prefix:
     description: The prefix of the installed Scarb

dist/cache-save/index.js

@@ -5,13 +5,13 @@ import fs from "fs/promises";
 
 import { getCacheDirectory, getCacheKey, State } from "./cache-utils";
 
-export async function restoreCache() {
+export async function restoreCache(scarbLockPath) {
   const cacheDir = await getCacheDirectory();
   await fs.mkdir(cacheDir, { recursive: true });
 
   core.info(`Restoring Scarb cache into ${cacheDir}`);
 
-  const primaryKey = await getCacheKey();
+  const primaryKey = await getCacheKey(scarbLockPath);
   core.info(`Cache primary key is ${primaryKey}`);
   core.saveState(State.CachePrimaryKey, primaryKey);
 

dist/cache-save/index.js.map

@@ -54,9 +54,9 @@ function wellKnownCachePath() {
   }
 }
 
-export async function getCacheKey() {
+export async function getCacheKey(scarbLockPath) {
   const platform = process.env.RUNNER_OS;
-  const fileHash = await glob.hashFiles(await getScarbLockfilePath());
+  const fileHash = await glob.hashFiles(await getScarbLockPath(scarbLockPath));
 
   if (!fileHash) {
     throw new Error(
@@ -67,8 +67,8 @@ export async function getCacheKey() {
   return `scarb-cache-${platform}-${fileHash}`.toLowerCase();
 }
 
-async function getScarbLockfilePath() {
-  const lockfilePath = path.join(process.env.GITHUB_WORKSPACE, "Scarb.lock");
+async function getScarbLockPath(scarbLockPath) {
+  const lockfilePath = scarbLockPath || "Scarb.lock";
 
   await fs.access(lockfilePath).catch((_) => {
     throw new Error("failed to find Scarb.lock");

dist/setup/index.js

@@ -14,6 +14,7 @@ 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 { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
@@ -47,7 +48,7 @@ export default async function main() {
 
     core.setOutput("scarb-version", await getFullVersionFromScarb());
 
-    await restoreCache().catch((e) => {
+    await restoreCache(scarbLockPathInput).catch((e) => {
       core.error(
         `There was an error when restoring cache: ${
           e instanceof Error ? e.message : e