Add bun-download-url to actions.yml and rebuild (#83)

* Add download URL

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release new action version
+
+on:
+  release:
+    types: [released]
+  workflow_dispatch:
+    inputs:
+      TAG_NAME:
+        description: 'Tag name that the major tag will point to'
+        required: true
+
+env:
+  TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
+
+jobs:
+  update_tag:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/publish-action@v0.3.0
+        with:
+          source-tag: ${{ env.TAG_NAME }}

.github/workflows/test.yml

@@ -16,18 +16,14 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        include:
-          - os: windows-latest
-            bun-version: canary
         os:
           - ubuntu-latest
           - macos-latest
+          - windows-latest
         bun-version:
           - latest
           - canary
-          - "0.8.1" # last version before 1.0
+          - "1.1.0"
-          - "0.x"
-          - "1.0.0"
           - "1.x"
           - "1"
           - "> 1.0.0"
@@ -38,13 +34,18 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Bun
         uses: ./
+        id: setup_bun
         with:
           bun-version: ${{ matrix.bun-version }}
+
       - name: Run Bun
+        id: run_bun
         run: |
           bun --version
+
   setup-bun-from-package-json-version:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -52,27 +53,73 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
+          - windows-latest
         packageManager:
-          - bun@1.0.0
+          - bun@1.1.0
-          - yarn@bun@1.0.0
+          - yarn@bun@1.1.0
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - name: Setup package.json
+        shell: bash
         run: |
           echo "$(jq '. += {"packageManager": "${{ matrix.packageManager }}"}' package.json)" > package.json
+
       - name: Setup Bun
         uses: ./
+
       - name: Run Bun
         id: bun
+        shell: bash
         run: |
           bun --version
           echo "version=$(bun --version)" >> $GITHUB_OUTPUT
+
       - name: Check version
+        shell: bash
         run: |
-          if [[ "${{ steps.bun.outputs.version }}" == "1.0.0" ]]; then
+          if [[ "${{ steps.bun.outputs.version }}" == "1.1.0" ]]; then
-            echo "Version is 1.0.0"
+            echo "Version is 1.1.0"
           else
-            echo "Expected version to be 1.0.0, got ${{ steps.bun.outputs.version }}"
+            echo "Expected version to be 1.1.0, got ${{ steps.bun.outputs.version }}"
             exit 1
-          fi
+          fi
+  setup-bun-from-tool-versions:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        content:
+          - "bun 1.1.0"
+          - "bun1.1.0"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup package.json
+        shell: bash
+        run: |
+          echo "bun ${{ matrix.content }}" > .tool-versions
+
+      - name: Setup Bun
+        uses: ./
+
+      - name: Run Bun
+        id: bun
+        shell: bash
+        run: |
+          bun --version
+          echo "version=$(bun --version)" >> $GITHUB_OUTPUT
+
+      - name: Check version
+        shell: bash
+        run: |
+          if [[ "${{ steps.bun.outputs.version }}" == "1.1.0" ]]; then
+            echo "Version is 1.1.0"
+          else
+            echo "Expected version to be 1.1.0, got ${{ steps.bun.outputs.version }}"
+            exit 1
+          fi

README.md

@@ -25,16 +25,21 @@ If you need to authenticate with a private registry, you can set the `BUN_AUTH_T
 - name: Install Dependencies
   env:
     BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-  run: bun install
+  run: bun install --frozen-lockfile
 ```
 
+### Node.js not needed
+
+In most cases, you shouldn't need to use the [setup-node](https://github.com/actions/setup-node) GitHub Action.
+
 ## Inputs
 
 | Name           | Description                                        | Default     | Examples                        |
 | -------------- | -------------------------------------------------- | ----------- | ------------------------------- |
 | `bun-version`  | The version of Bun to download and install.        | `latest`    | `canary`, `1.0.0`, `1.0.x`      |
 | `registry-url` | Registry URL where some private package is stored. | `undefined` | `"https://npm.pkg.github.com/"` |
-| `scope`        | Scope for private pacakages.                       | `undefined` | `"@foo"`, `"@orgname"`          |
+| `scope`        | Scope for private packages.                        | `undefined` | `"@foo"`, `"@orgname"`          |
+| `no-cache`     | Disable caching of the downloaded executable.      | `false`     | `true`, `false`                 |
 
 ## Outputs
 

action.yml

@@ -5,6 +5,9 @@ branding:
   icon: play-circle
   color: white
 inputs:
+  bun-download-url:
+    description: "Override the URL to download Bun from. This skips version resolution and verifying AVX2 support."
+    required: false
   bun-version:
     description: 'The version of Bun to install. (e.g. "latest", "canary", "1.0.0", "1.0.x", <sha>)'
     required: false
@@ -14,6 +17,11 @@ inputs:
   scope:
     required: false
     description: "The scope for authenticating with the package registry."
+  no-cache:
+    required: false
+    type: boolean
+    default: false
+    description: "Disable caching of bun executable."
 outputs:
   bun-version:
     description: The version of Bun that was installed.
@@ -22,5 +30,7 @@ outputs:
   cache-hit:
     description: If the version of Bun was cached.
 runs:
-  using: node20
+  using: "node20"
-  main: dist/index.js
+  main: "dist/setup/index.js"
+  post: "dist/cache-save/index.js"
+  post-if: success()

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "setup-bun",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "setup-bun",
-      "version": "1.1.1",
+      "version": "1.2.1",
       "license": "MIT",
       "dependencies": {
         "@actions/cache": "^3.1.4",

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "setup-bun",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "Setup Bun on GitHub Actions.",
   "keywords": [
     "bun",
@@ -18,8 +18,8 @@
   "author": "xHyroM",
   "scripts": {
     "format": "prettier --write src *.yml *.json *.md",
-    "build": "esbuild --target=node20 --outdir=dist --bundle --minify --platform=node --format=cjs src/index.ts",
+    "build": "esbuild --target=node20 --outfile=dist/setup/index.js --bundle --minify --platform=node --format=cjs src/index.ts && esbuild --target=node20 --outfile=dist/cache-save/index.js --bundle --minify --platform=node --format=cjs src/cache-save.ts",
-    "start": "npm run build && node dist/index.js"
+    "start": "npm run build && node dist/setup/index.js"
   },
   "dependencies": {
     "@actions/cache": "^3.1.4",

src/action.ts

@@ -8,10 +8,12 @@ import {
   copyFileSync,
 } from "node:fs";
 import { addPath, info, warning } from "@actions/core";
-import { isFeatureAvailable, restoreCache, saveCache } from "@actions/cache";
+import { isFeatureAvailable, restoreCache } from "@actions/cache";
 import { downloadTool, extractZip } from "@actions/tool-cache";
 import { getExecOutput } from "@actions/exec";
 import { writeBunfig } from "./bunfig";
+import { saveState } from "@actions/core";
+import { retry } from "./utils";
 
 export type Input = {
   customUrl?: string;
@@ -22,6 +24,7 @@ export type Input = {
   profile?: boolean;
   scope?: string;
   registryUrl?: string;
+  noCache?: boolean;
 };
 
 export type Output = {
@@ -30,6 +33,13 @@ export type Output = {
   cacheHit: boolean;
 };
 
+export type CacheState = {
+  cacheEnabled: boolean;
+  cacheHit: boolean;
+  bunPath: string;
+  url: string;
+};
+
 export default async (options: Input): Promise<Output> => {
   const bunfigPath = join(process.cwd(), "bunfig.toml");
   writeBunfig(bunfigPath, options);
@@ -77,17 +87,8 @@ export default async (options: Input): Promise<Output> => {
 
   if (!cacheHit) {
     info(`Downloading a new version of Bun: ${url}`);
-    const zipPath = await downloadTool(url);
+    // TODO: remove this, temporary fix for https://github.com/oven-sh/setup-bun/issues/73
-    const extractedZipPath = await extractZip(zipPath);
+    revision = await retry(async () => await downloadBun(url, bunPath), 3);
-    const extractedBunPath = await extractBun(extractedZipPath);
-    try {
-      renameSync(extractedBunPath, bunPath);
-    } catch {
-      // If mv does not work, try to copy the file instead.
-      // For example: EXDEV: cross-device link not permitted
-      copyFileSync(extractedBunPath, bunPath);
-    }
-    revision = await getRevision(bunPath);
   }
 
   if (!revision) {
@@ -96,15 +97,17 @@ export default async (options: Input): Promise<Output> => {
     );
   }
 
-  if (cacheEnabled && !cacheHit) {
-    try {
-      await saveCache([bunPath], url);
-    } catch (error) {
-      warning("Failed to save Bun to cache.");
-    }
-  }
-
   const [version] = revision.split("+");
+
+  const cacheState: CacheState = {
+    cacheEnabled,
+    cacheHit,
+    bunPath,
+    url,
+  };
+
+  saveState("cache", JSON.stringify(cacheState));
+
   return {
     version,
     revision,
@@ -112,8 +115,29 @@ export default async (options: Input): Promise<Output> => {
   };
 };
 
+async function downloadBun(
+  url: string,
+  bunPath: string
+): Promise<string | undefined> {
+  const zipPath = await downloadTool(url);
+  const extractedZipPath = await extractZip(zipPath);
+  const extractedBunPath = await extractBun(extractedZipPath);
+  try {
+    renameSync(extractedBunPath, bunPath);
+  } catch {
+    // If mv does not work, try to copy the file instead.
+    // For example: EXDEV: cross-device link not permitted
+    copyFileSync(extractedBunPath, bunPath);
+  }
+
+  return await getRevision(bunPath);
+}
+
 function isCacheEnabled(options: Input): boolean {
-  const { customUrl, version } = options;
+  const { customUrl, version, noCache } = options;
+  if (noCache) {
+    return false;
+  }
   if (customUrl) {
     return false;
   }

src/cache-save.ts

@@ -0,0 +1,15 @@
+import { saveCache } from "@actions/cache";
+import { getState, warning } from "@actions/core";
+import { CacheState } from "./action";
+
+(async () => {
+  const state: CacheState = JSON.parse(getState("cache"));
+  if (state.cacheEnabled && !state.cacheHit) {
+    try {
+      await saveCache([state.bunPath], state.url);
+      process.exit(0);
+    } catch (error) {
+      warning("Failed to save Bun to cache.");
+    }
+  }
+})();

src/index.ts

@@ -1,7 +1,13 @@
 import { tmpdir } from "node:os";
 import { join } from "node:path";
 import { existsSync, readFileSync } from "node:fs";
-import { getInput, setOutput, setFailed, warning } from "@actions/core";
+import {
+  getInput,
+  setOutput,
+  setFailed,
+  warning,
+  getBooleanInput,
+} from "@actions/core";
 import runAction from "./action.js";
 
 if (!process.env.RUNNER_TEMP) {
@@ -30,17 +36,44 @@ function readVersionFromPackageJson(): string | undefined {
   }
 }
 
+function readVersionFromToolVersions(): string | undefined {
+  const cwd = process.env.GITHUB_WORKSPACE;
+  if (!cwd) {
+    return;
+  }
+  const path = join(cwd, ".tool-versions");
+  try {
+    if (!existsSync(path)) {
+      return;
+    }
+
+    const match = readFileSync(path, "utf8").match(/^bun\s(?<version>.*?)$/m);
+
+    return match?.groups?.version;
+  } catch (error) {
+    const { message } = error as Error;
+    warning(`Failed to read .tool-versions: ${message}`);
+  }
+}
+
 runAction({
-  version: getInput("bun-version") || readVersionFromPackageJson() || undefined,
+  version:
+    getInput("bun-version") ||
+    readVersionFromPackageJson() ||
+    readVersionFromToolVersions() ||
+    undefined,
   customUrl: getInput("bun-download-url") || undefined,
   registryUrl: getInput("registry-url") || undefined,
   scope: getInput("scope") || undefined,
+  noCache: getBooleanInput("no-cache") || false,
 })
   .then(({ version, revision, cacheHit }) => {
     setOutput("bun-version", version);
     setOutput("bun-revision", revision);
     setOutput("cache-hit", cacheHit);
+    process.exit(0);
   })
   .catch((error) => {
     setFailed(error);
+    process.exit(1);
   });

src/utils.ts

@@ -0,0 +1,14 @@
+export function retry<T>(
+  fn: () => Promise<T>,
+  retries: number,
+  timeout = 10000
+): Promise<T> {
+  return fn().catch((err) => {
+    if (retries <= 0) {
+      throw err;
+    }
+    return new Promise((resolve) => setTimeout(resolve, timeout)).then(() =>
+      retry(fn, retries - 1, timeout)
+    );
+  });
+}