Releases: oven-sh/setup-bun
v2.0.1
oven-sh/setup-bun
is the github action for setting up Bun.
This releases fixes false warning when you don't have any parameters in action (#90) thanks to @Araxeus
What's Changed
- docs: show correct bun-version-file examples by @xhyrom in #86
- fix: bun-version-file default value by @Araxeus in #90
New Contributors
Full Changelog: v1...v2
v2
v1.2.2
oven-sh/setup-bun
is the github action for setting up Bun.
This release introduces support for the bun-download-url
input, which lets you override the URL used to download the .zip file for Bun.
Here's an example:
- name: Setup Bun
uses: oven-sh/setup-bun@v1.2.2
with:
bun-version: latest
bun-download-url: "https://github.com/oven-sh/bun/releases/latest/download/bun-${{runner.os == 'macOS' && 'darwin' || runner.os}}-${{ runner.arch == 'X64' && 'x64' || 'arm64' }}.zip"
v1
setup-bun v1
Download, install, and setup Bun in GitHub Actions.
Usage
Latest release
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
Specific release
- uses: oven-sh/setup-bun@v1
with:
bun-version: "0.5.6"
Canary release
- uses: oven-sh/setup-bun@v1
with:
bun-version: canary
Specific canary release
- uses: oven-sh/setup-bun@v1
with:
bun-version: 9be68ac2350b965037f408ce4d47c3b9d9a76b63
Action run
- uses: oven-sh/setup-bun@v1
with:
bun-version: "action:4308768069"
Custom download URL
- uses: oven-sh/setup-bun@v1
with:
bun-download-url: https://example.com/path/to/bun.zip
v1.2.1
setup-bun v1.2.1
Download, install, and setup Bun in GitHub Actions.
Usage
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
Using a custom NPM registry
- uses: oven-sh/setup-bun@v1
with:
registry-url: "https://npm.pkg.github.com/"
scope: "@foo"
If you need to authenticate with a private registry, you can set the BUN_AUTH_TOKEN
environment variable.
- name: Install Dependencies
env:
BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: bun install --frozen-lockfile
Node.js not needed
In most cases, you shouldn't need to use the 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 packages. | undefined |
"@foo" , "@orgname" |
no-cache |
Disable caching of the downloaded executable. | false |
true , false |
Outputs
Name | Description | Example |
---|---|---|
cache-hit |
If the Bun executable was read from cache. | true |
bun-version |
The output from bun --version . |
1.0.0 |
bun-revision |
The output from bun --revision . |
1.0.0+822a00c4 |
What's Changed
- build: bump ci actions by @xhyrom in #66
- feat: support .tool-versions by @xhyrom in #68
- fix: retry installing three times, add windows for testing by @xhyrom in #72
- fix: close immediately by @xhyrom in #75
Full Changelog: v1.2.0...v1.2.1
v1.2.0
setup-bun v1.2.0
Download, install, and setup Bun in GitHub Actions.
Usage
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
Using a custom NPM registry
- uses: oven-sh/setup-bun@v1
with:
registry-url: "https://npm.pkg.github.com/"
scope: "@foo"
If you need to authenticate with a private registry, you can set the BUN_AUTH_TOKEN
environment variable.
- name: Install Dependencies
env:
BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: bun install --frozen-lockfile
Node.js not needed
In most cases, you shouldn't need to use the 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 packages. | undefined |
"@foo" , "@orgname" |
no-cache |
Disable caching of the downloaded executable. | false |
true , false |
Outputs
Name | Description | Example |
---|---|---|
cache-hit |
If the Bun executable was read from cache. | true |
bun-version |
The output from bun --version . |
1.0.0 |
bun-revision |
The output from bun --revision . |
1.0.0+822a00c4 |
What's Changed
- docs: add explanatory note about setup-node by @PaulRBerg in #47
- Add GitHub action to auto-update the v1 tag by @jcbhmr in #53
- docs: add --frozen-lockfile to README by @blimmer in #52
- Fix typo in README.md by @starsep in #57
- Move cache save to runs.post and exit early by @andyexeter in #60
- Add no-cache option by @maschwenk in #58
New Contributors
- @PaulRBerg made their first contribution in #47
- @jcbhmr made their first contribution in #53
- @blimmer made their first contribution in #52
- @starsep made their first contribution in #57
- @andyexeter made their first contribution in #60
- @maschwenk made their first contribution in #58
Full Changelog: v1...v1.2.0
v1.1.1
setup-bun v1.1.0
Download, install, and setup Bun in GitHub Actions.
Usage
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
Using a custom NPM registry
- uses: oven-sh/setup-bun@v1
with:
registry-url: "https://npm.pkg.github.com/"
scope: "@foo"
If you need to authenticate with a private registry, you can set the BUN_AUTH_TOKEN
environment variable.
- name: Install Dependencies
env:
BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: bun install
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" |
Outputs
Name | Description | Example |
---|---|---|
cache-hit |
If the Bun executable was read from cache. | true |
bun-version |
The output from bun --version . |
1.0.0 |
bun-revision |
The output from bun --revision . |
1.0.0+822a00c4 |
What's Changed
Full Changelog: v1.1.0...v1.1.1
v1.1.0
setup-bun v1.1.0
Download, install, and setup Bun in GitHub Actions.
Usage
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
Using a custom NPM registry
- uses: oven-sh/setup-bun@v1
with:
registry-url: "https://npm.pkg.github.com/"
scope: "@foo"
If you need to authenticate with a private registry, you can set the BUN_AUTH_TOKEN
environment variable.
- name: Install Dependencies
env:
BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: bun install
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" |
Outputs
Name | Description | Example |
---|---|---|
cache-hit |
If the Bun executable was read from cache. | true |
bun-version |
The output from bun --version . |
1.0.0 |
bun-revision |
The output from bun --revision . |
1.0.0+822a00c4 |
v0.1.8
Update dependencies, node
Full Changelog: v0.1.7...v0.1.8
v0.1.7
Full Changelog: v0.1.6...v0.1.7
Support for repository
& custom-download-url
inputs
Check README and workflow