Add version Input

README.md

@@ -27,9 +27,10 @@ If you are new to GitHub Actions, you can explore the [GitHub Actions guide](htt
 
 Here are the available input parameters for the Setup Yarn Berry Action:
 
-| Name    | Type              | Default | Description                                                |
-| ------- | ----------------- | ------- | ---------------------------------------------------------- |
-| `cache` | `true` or `false` | `true`  | Indicates whether to use caching during Yarn installation. |
+| Name      | Type              | Default | Description                                                                                                                                                                           |
+| --------- | ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `version` | String            |         | Specifies the version of Yarn to be set up using this action. The specified version can be a tag (e.g., `stable`), a semver range (e.g., `4.x`), or a semver version (e.g., `4.1.0`). |
+| `cache`   | `true` or `false` | `true`  | Indicates whether to use caching during Yarn installation.                                                                                                                            |
 
 ### Example
 
@@ -53,6 +54,17 @@ jobs:
       # Add more steps as needed for your workflow
 ```
 
+#### Specifying Yarn Version
+
+You can specify the Yarn version to be used by providing it as an input parameter:
+
+```yaml
+- name: Setup Latest Yarn
+  uses: threeal/setup-yarn-action@v1.0.0
+  with:
+    version: latest
+```
+
 #### Disabling Caching
 
 By default, caching is enabled. To disable caching, set the `cache` input parameter to `false` as shown below:

action.yaml

@@ -5,6 +5,8 @@ branding:
   icon: chevrons-right
   color: black
 inputs:
+  version:
+    description: The Yarn version to be set up
   cache:
     description: Use caching during Yarn installation
     default: true

src/inputs.test.ts

@@ -2,10 +2,11 @@ import { jest } from "@jest/globals";
 
 jest.unstable_mockModule("@actions/core", () => ({
   getBooleanInput: jest.fn(),
+  getInput: jest.fn(),
 }));
 
 beforeEach(async () => {
-  const { getBooleanInput } = await import("@actions/core");
+  const { getBooleanInput, getInput } = await import("@actions/core");
 
   jest.mocked(getBooleanInput).mockImplementation((name) => {
     switch (name) {
@@ -14,12 +15,20 @@ beforeEach(async () => {
     }
     throw new Error(`unknown input: ${name}`);
   });
+
+  jest.mocked(getInput).mockImplementation((name) => {
+    switch (name) {
+      case "version":
+        return "";
+    }
+    throw new Error(`unknown input: ${name}`);
+  });
 });
 
 it("should get the action inputs", async () => {
   const { getInputs } = await import("./inputs.js");
 
   const inputs = getInputs();
 
-  expect(inputs).toStrictEqual({ cache: true });
+  expect(inputs).toStrictEqual({ version: "", cache: true });
 });

src/inputs.ts

@@ -1,7 +1,13 @@
-import { getBooleanInput } from "@actions/core";
+import { getBooleanInput, getInput } from "@actions/core";
 
-export function getInputs() {
+interface Inputs {
+  version: string;
+  cache: boolean;
+}
+
+export function getInputs(): Inputs {
   return {
+    version: getInput("version"),
     cache: getBooleanInput("cache"),
   };
 }

src/main.test.ts

@@ -14,6 +14,7 @@ jest.unstable_mockModule("@actions/core", () => ({
 }));
 
 jest.unstable_mockModule("./yarn/index.js", () => ({
+  setYarnVersion: jest.fn(),
   yarnInstall: jest.fn(),
 }));
 
@@ -38,7 +39,7 @@ describe("install Yarn dependencies", () => {
   beforeEach(async () => {
     const { restoreCache, saveCache } = await import("@actions/cache");
     const core = await import("@actions/core");
-    const { yarnInstall } = await import("./yarn/index.js");
+    const { setYarnVersion, yarnInstall } = await import("./yarn/index.js");
     const { getCacheKey, getCachePaths } = await import("./cache.js");
     const { corepackEnableYarn } = await import("./corepack.js");
     const { getInputs } = await import("./inputs.js");
@@ -90,14 +91,18 @@ describe("install Yarn dependencies", () => {
       core.info("Yarn enabled");
     });
 
+    jest.mocked(setYarnVersion).mockImplementation(async (version) => {
+      core.info(`Yarn version set to ${version}`);
+    });
+
     jest.mocked(yarnInstall).mockImplementation(async () => {
       core.info("Dependencies installed");
     });
 
     jest.mocked(getCacheKey).mockResolvedValue("unavailable-key");
     jest.mocked(getCachePaths).mockResolvedValue(["some/path", "another/path"]);
 
-    jest.mocked(getInputs).mockReturnValue({ cache: true });
+    jest.mocked(getInputs).mockReturnValue({ version: "", cache: true });
   });
 
   it("should failed to enable Yarn", async () => {
@@ -288,11 +293,70 @@ describe("install Yarn dependencies", () => {
     ]);
   });
 
+  describe("with version specified", () => {
+    beforeEach(async () => {
+      const { getInputs } = await import("./inputs.js");
+
+      jest.mocked(getInputs).mockReturnValue({
+        version: "stable",
+        cache: true,
+      });
+    });
+
+    it("should failed to set Yarn version", async () => {
+      const { setYarnVersion } = await import("./yarn/index.js");
+      const { main } = await import("./main.js");
+
+      jest.mocked(setYarnVersion).mockRejectedValue(new Error("some error"));
+
+      await main();
+
+      expect(failed).toBe(true);
+      expect(logs).toStrictEqual([
+        "Getting action inputs...",
+        "Enabling Yarn...",
+        "Yarn enabled",
+        "Setting Yarn version...",
+        "Failed to set Yarn version: some error",
+      ]);
+    });
+
+    it("should successfully install dependencies", async () => {
+      const { main } = await import("./main.js");
+
+      await main();
+
+      expect(failed).toBe(false);
+      expect(logs).toStrictEqual([
+        "Getting action inputs...",
+        "Enabling Yarn...",
+        "Yarn enabled",
+        "Setting Yarn version...",
+        "Yarn version set to stable",
+        "::group::Getting cache key",
+        "::endgroup::",
+        "::group::Getting cache paths",
+        "::endgroup::",
+        "::group::Restoring cache",
+        "Cache not found",
+        "::endgroup::",
+        "::group::Installing dependencies",
+        "Dependencies installed",
+        "::endgroup::",
+        "::group::Saving cache",
+        "Compressing some/path...",
+        "Compressing another/path...",
+        "Cache unavailable-key saved",
+        "::endgroup::",
+      ]);
+    });
+  });
+
   describe("with cache disabled", () => {
     beforeEach(async () => {
       const { getInputs } = await import("./inputs.js");
 
-      jest.mocked(getInputs).mockReturnValue({ cache: false });
+      jest.mocked(getInputs).mockReturnValue({ version: "", cache: false });
     });
 
     it("should successfully install dependencies", async () => {

src/main.ts

@@ -2,7 +2,7 @@ import * as cache from "@actions/cache";
 import * as core from "@actions/core";
 import { getCacheKey, getCachePaths } from "./cache.js";
 import { corepackAssertYarnVersion, corepackEnableYarn } from "./corepack.js";
-import { yarnInstall } from "./yarn/index.js";
+import { setYarnVersion, yarnInstall } from "./yarn/index.js";
 import { getInputs } from "./inputs.js";
 
 export async function main(): Promise<void> {
@@ -18,6 +18,17 @@ export async function main(): Promise<void> {
     return;
   }
 
+  if (inputs.version != "") {
+    core.info("Setting Yarn version...");
+    try {
+      await setYarnVersion(inputs.version);
+      await corepackAssertYarnVersion();
+    } catch (err) {
+      core.setFailed(`Failed to set Yarn version: ${err.message}`);
+      return;
+    }
+  }
+
   let cacheKey: string;
   let cachePaths: string[];
   if (inputs.cache) {