setup-bun

Use the oven-sh/setup-bun@v2 action to download, install, and set up Bun in your GitHub Actions workflows.

By default, if no version is specified, the action follows this resolution order:

1. Checks package.json for the packageManager field (e.g., "packageManager": "bun@1.0.25").
2. If packageManager is missing, checks package.json for engines.bun.
3. If neither is found or package.json is missing, it defaults to latest.

- uses: oven-sh/setup-bun@v2

You can configure multiple package registries (both default and scoped) using the registries input. This allows Bun to authenticate with private or internal registries during bun install.

Important: When using authentication tokens or credentials, you must ensure the corresponding environment variables are set in the workflow steps that perform the installation (e.g., bun install).

- uses: oven-sh/setup-bun@v2
  with:
    registries: |
      https://registry.npmjs.org/
      @myorg:https://npm.pkg.github.com/|$GITHUB_TOKEN
      @internal:https://username:$INTERNAL_PASSWORD@registry.internal.com/

- name: Install dependencies
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    INTERNAL_PASSWORD: ${{ secrets.INTERNAL_PASSWORD }}
  run: bun install

If you need to point the action to a specific location for the Bun release (e.g., a mirror or a specific architecture zip), use the bun-download-url input.

- uses: oven-sh/setup-bun@v2
  with:
    bun-download-url: "https://github.com/oven-sh/bun/releases/latest/download/bun-linux-x64.zip"

You can explicitly define which version of Bun to install using the bun-version input. Supported values include specific versions (e.g., 1.0.0), ranges (e.g., 1.0.x), or special tags like latest and canary.

- uses: oven-sh/setup-bun@v2
  with:
    bun-version: latest

To use a version specified in a specific file, use the bun-version-file input. This is useful for keeping Bun versions in sync with other versioning files like .bun-version or .tool-versions.

- uses: oven-sh/setup-bun@v2
  with:
    bun-version-file: ".bun-version"

The following outputs are available after the action runs:

When providing the registries input, use the following formats to define your registry access:

The following inputs are available for the oven-sh/setup-bun@v2 action:

The parseRegistries function converts a newline-delimited string of registry configurations into an array of Registry objects. Each object contains the url, the scope (which is an empty string if no scope is provided), and an optional token.

import { parseRegistries } from './src/registry';

const input = `
https://registry.npmjs.org/|my-token
@myorg:https://registry.myorg.com/
`;

const registries = parseRegistries(input);
// Result:
// [
//   { url: 'https://registry.npmjs.org/', scope: '', token: 'my-token' },
//   { url: 'https://registry.myorg.com/', scope: '@myorg' }
// ]

The setup-bun action provides the following outputs which can be used in subsequent steps of your workflow:

type Output = {
  version: string;
  revision: string;
  bunPath: string;
  url: string;
  cacheHit: boolean;
};

When using the setup-bun GitHub Action, you can provide several inputs to control the Bun installation. Note that certain inputs like customUrl or noCache will disable caching behavior.

- uses: oven-sh/setup-bun@v2
  with:
    version: '1.0.0'
    os: 'ubuntu-22.04'
    arch: 'x64'
    avx2: true
    profile: true
    registries: '[{ "url": "https://my-registry.com/", "token": "MY_TOKEN" }]'
    noCache: false
    token: 'GH_TOKEN'
    customUrl: 'https://custom.url/bun.zip'

After the action completes, it provides several outputs that you can use in subsequent steps of your GitHub Actions workflow:

• bun-version: The version of Bun that was installed.
• bun-revision: The specific revision of Bun used.
• bun-path: The file system path where the Bun binary was installed.
• bun-download-url: The URL from which the Bun binary was downloaded.
• cache-hit: A boolean indicating if the installation was retrieved from the cache.

- uses: oven-sh/setup-bun@v2
  id: setup-bun

- name: Use Bun
  run: | 
    echo "Version: ${{ steps.setup-bun.outputs.bun-version }}"
    echo "Path: ${{ steps.setup-bun.outputs.bun-path }}"