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