mirror of
https://github.com/oven-sh/setup-bun.git
synced 2025-07-12 22:13:12 +08:00
34f777aec1
* feat: support for multiple registries * [autofix.ci] apply automated fixes * refactor: drop unnecessary check * fix: pass empty array instead undefined * [autofix.ci] apply automated fixes * fix: dont add registry set line * [autofix.ci] apply automated fixes * feat: few more tests * feat: add bun types * docs: explain registries * feat: save globally * [autofix.ci] apply automated fixes * ci: jsr registry test * ci: add , * ci: test * ci: test * ci: test * ci: test * [autofix.ci] apply automated fixes * feat: use @iarna/toml * [autofix.ci] apply automated fixes * feat: registry parsing * [autofix.ci] apply automated fixes * ci: verbose add * ci: registry install check * ci: registry install check * ci: registry install check * ci: verify registry usage * docs: registries * docs: important block * docs: show table * docs: show table * ci: shell * ci: registry test on linux * ci: registry test on linux * build: text lockfile --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
4.2 KiB
4.2 KiB
setup-bun
Download, install, and setup Bun in GitHub Actions.
Usage
- uses: oven-sh/setup-bun@v2
with:
bun-version: latest
Using version file
- uses: oven-sh/setup-bun@v2
with:
bun-version-file: ".bun-version"
Using custom registries
You can configure multiple package registries using the registries input. This supports both default and scoped registries with various authentication methods.
Registry configuration
- 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
Registry format options
| Type | Format |
|---|---|
| Default registry | https://registry.example.com/ |
| Default registry with token | https://registry.example.com/|$TOKEN |
| Scoped registry | @scope:https://registry.example.com/ |
| Scoped registry with token | @scope:https://registry.example.com/|$TOKEN |
| Scoped registry with URL credentials | @scope:https://username:$PASSWORD@registry.example.com/ |
Important
When using authentication, make sure to set the corresponding environment variables in your workflow steps that need access to the registries.
For more information about configuring registries in Bun, see the official documentation.
Override download url
If you need to override the download URL, you can 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"
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 |
bun-version-file |
The version of Bun to download and install from file. | undefined |
package.json, .bun-version, .tool-versions |
bun-download-url |
URL to download .zip file for Bun release | ||
registry-url |
Registry URL where some private package is stored. | undefined |
"https://npm.pkg.github.com/" |
scope |
Scope for private packages. | undefined |
"@foo", "@orgname" |
Outputs
| Name | Description | Example |
|---|---|---|
bun-version |
The output from bun --version. |
1.0.0 |
bun-revision |
The output from bun --revision. |
1.0.0+822a00c4 |
bun-path |
The path to the Bun executable. | /path/to/bun |
bun-download-url |
The URL from which Bun was downloaded. | https://bun.sh/download/latest/linux/x64?avx2=true&profile=false |
cache-hit |
If the Bun executable was read from cache. | true |