GitHub Action
Setup Bun Runtime
v1.13.2
Latest version
Setup GitHub Actions workflow with a specific version of Bun and add
$BUN_INSTALL/bin
to the$PATH
.
- macOS x64 & Silicon, Linux x64, Windows Subsystem for Linux
- name: Setup Bun Runtime
uses: antongolub/action-setup-bun@v1 # or @v1.x.x
with:
# Optional, if empty the latest bun version will be used
# Examples: 0.0.77, 0.1.2, >=0.1, *
bun-version: 0.1.2
# Optional, default is 'Jarred-Sumner/bun-releases-for-updater'
# Example: oven-sh/misc-test-builds
bun-repo: 'Jarred-Sumner/bun-releases-for-updater'
# Override bunfig.toml inners
# Optional. JSON-formatted string as input
# See: https://github.com/oven-sh/bun#bunfigtoml
bun-config: '{"install": {"production": false}}'
# Attach $BUN_INSTALL/install/cache to action/cache
# Optional, defaults to false
cache: true
# actions/tool-cache provides a cache for the current job only
# Use actions/cache to store the bun binary for the whole workflow
# Optional, defaults to false
cache-bin: true
# Optional, default is process.platform
# Examples: darwin, linux
platform: 'linux'
# Optional, default is process.arch
# Examples: x64, arm64
arch: 'x64'
# Authenticated requests get a higher rate limit
# Optional. Defaults to ${{ github.token }}
token: 'gh-token'
- name: Run script
run: bun index.js
There are at least 3 known places to fetch bun distributions:
The env.HOME
is used to store the bun
binary (${HOME}/.bun/bin
). If you want to assign another directory, you can override this env
option.
env:
HOME: '/custom/path'
Name | Description |
---|---|
bun-version |
The version of Bun that was installed |
cache-hit |
if the bun cache was hit: true / false |
error |
if an error occurred, the error message |
This flag can be enabled by setting the secret ACTIONS_STEP_DEBUG
to true
.