✨ tool-versions option (#17)

Solves #14

---------

Co-authored-by: Marek Kaput <marek.kaput@outlook.com>

.github/workflows/ci.yml

@@ -79,6 +79,14 @@ jobs:
         uses: ./
       - run: scarb --version | grep "scarb 0.7.0"
 
+      - name: "Create .tool-versions file in subfolder"
+        run: mkdir ./tmp && echo "scarb 0.7.0" >> ./tmp/.tool-versions
+      - name: "Setup Scarb using `.tool-versions` file in subfolder"
+        uses: ./
+        with:
+          tool-versions: ./tmp/.tool-versions
+      - run: scarb --version | grep "scarb 0.7.0"
+
   lint:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -30,6 +30,9 @@ jobs:
   - `"nightly"` to download latest nightly version.
   - Empty/not specified: the `.tool-versions` file will be read to resolve Scarb version, and in case it is not
     present the latest stable version will be used.
+- `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.
 
 ## Outputs
 

dist/setup/index.js

@@ -60386,9 +60386,29 @@ var lib = __nccwpck_require__(6255);
 
 
 
-async function determineVersion(version, { repo, nightliesRepo }) {
+
+async function determineVersion(
+  version,
+  toolVersionsPath,
+  { repo, nightliesRepo },
+) {
   version = version?.trim();
 
+  if (version && toolVersionsPath) {
+    throw new Error(
+      "the `scarb-version` and `tool-versions` inputs cannot be used simultaneously",
+    );
+  }
+
+  if (toolVersionsPath) {
+    let toolVersion = await getVersionFromToolVersionsFile(toolVersionsPath);
+
+    if (!toolVersion) {
+      throw new Error(`failed to read Scarb version from: ${toolVersionsPath}`);
+    }
+    version = toolVersion;
+  }
+
   if (!version) {
     let toolVersion = await getVersionFromToolVersionsFile();
     version = toolVersion ?? "latest";
@@ -60469,9 +60489,10 @@ function fetchLatestTag(repo) {
   );
 }
 
-async function getVersionFromToolVersionsFile() {
+async function getVersionFromToolVersionsFile(toolVersionsPath) {
   try {
-    const toolVersions = await promises_default().readFile(".tool-versions", {
+    toolVersionsPath = toolVersionsPath || ".tool-versions";
+    const toolVersions = await promises_default().readFile(toolVersionsPath, {
       encoding: "utf-8",
     });
     return toolVersions.match(/^scarb ([\w.-]+)/m)?.[1];
@@ -60681,8 +60702,11 @@ async function restoreCache() {
 async function main() {
   try {
     const scarbVersionInput = core.getInput("scarb-version");
+    const toolVersionsPathInput = core.getInput("tool-versions");
+
     const { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
+      toolVersionsPathInput,
       {
         repo: "software-mansion/scarb",
         nightliesRepo: "software-mansion/scarb-nightlies",

lib/main.js

@@ -13,8 +13,11 @@ import { restoreCache } from "./cache-restore";
 export default async function main() {
   try {
     const scarbVersionInput = core.getInput("scarb-version");
+    const toolVersionsPathInput = core.getInput("tool-versions");
+
     const { repo: scarbRepo, version: scarbVersion } = await determineVersion(
       scarbVersionInput,
+      toolVersionsPathInput,
       {
         repo: "software-mansion/scarb",
         nightliesRepo: "software-mansion/scarb-nightlies",

lib/versions.js

@@ -2,10 +2,30 @@ import fs from "fs/promises";
 import * as core from "@actions/core";
 import * as exec from "@actions/exec";
 import { HttpClient } from "@actions/http-client";
+import path from "path";
 
-export async function determineVersion(version, { repo, nightliesRepo }) {
+export async function determineVersion(
+  version,
+  toolVersionsPath,
+  { repo, nightliesRepo },
+) {
   version = version?.trim();
 
+  if (version && toolVersionsPath) {
+    throw new Error(
+      "the `scarb-version` and `tool-versions` inputs cannot be used simultaneously",
+    );
+  }
+
+  if (toolVersionsPath) {
+    let toolVersion = await getVersionFromToolVersionsFile(toolVersionsPath);
+
+    if (!toolVersion) {
+      throw new Error(`failed to read Scarb version from: ${toolVersionsPath}`);
+    }
+    version = toolVersion;
+  }
+
   if (!version) {
     let toolVersion = await getVersionFromToolVersionsFile();
     version = toolVersion ?? "latest";
@@ -86,9 +106,10 @@ function fetchLatestTag(repo) {
   );
 }
 
-async function getVersionFromToolVersionsFile() {
+async function getVersionFromToolVersionsFile(toolVersionsPath) {
   try {
-    const toolVersions = await fs.readFile(".tool-versions", {
+    toolVersionsPath = toolVersionsPath || ".tool-versions";
+    const toolVersions = await fs.readFile(toolVersionsPath, {
       encoding: "utf-8",
     });
     return toolVersions.match(/^scarb ([\w.-]+)/m)?.[1];