mirror of
https://github.com/oven-sh/setup-bun.git
synced 2025-02-23 10:40:10 +08:00
ef00e4ac8e
* feat: add input bun-version-file (#76) * feat: add input for bun-version-file * docs: update example bun version file * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * refactor: reduce read from file code * [autofix.ci] apply automated fixes * feat: read from all known files if not specified * [autofix.ci] apply automated fixes * fix: just continue if file doesnt exist * [autofix.ci] apply automated fixes * fix: return output if found version * [autofix.ci] apply automated fixes * fix: make whitespace in .tool-versions optional * [autofix.ci] apply automated fixes * log loglog * [autofix.ci] apply automated fixes * log log log * [autofix.ci] apply automated fixes * better warnings, fix ci failing * [autofix.ci] apply automated fixes * feat: log obtained version * [autofix.ci] apply automated fixes * build: bump version * [autofix.ci] apply automated fixes * fix: add .zip extension if it's not present Workaround for https://github.com/actions/toolkit/issues/1179 Fixes https://github.com/oven-sh/setup-bun/issues/79 * [autofix.ci] apply automated fixes * docs: add comment for easier understanding * ci: more readable version * ci: match name * docs: add package.json and .tool-versions to bun-version-file examples * ci: add cache test * ci: install another pkg for cache test * ci: install more pkgs for cache test * ci: block all trusted deps in cache test * ci: more deps for cache test * ci: cache test should cache * refactor: dont try all files if not defined * [autofix.ci] apply automated fixes * ci: remove cache test * feat: support .bunrc * [autofix.ci] apply automated fixes * refactor: .bun-version instead .bunrc * [autofix.ci] apply automated fixes * feat: add bun paths and url to output Fixes https://github.com/oven-sh/setup-bun/issues/81 * [autofix.ci] apply automated fixes * ci: test for .bun-version * feat: make .bun-version as default in bun-version-file * ci: remove cache before test * ci: remove cache before test * ci: remove cache before test * ci: remove cache before test --------- Co-authored-by: Ade Hery Shopyan <51158020+adeherysh@users.noreply.github.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
# setup-bun
|
|
|
|
Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- uses: oven-sh/setup-bun@v1
|
|
with:
|
|
bun-version: latest
|
|
```
|
|
|
|
## Using version file
|
|
|
|
```yaml
|
|
- uses: oven-sh/setup-bun@v1
|
|
with:
|
|
bun-version-file: ".bumrc"
|
|
```
|
|
|
|
### Using a custom NPM registry
|
|
|
|
```yaml
|
|
- 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.
|
|
|
|
```yaml
|
|
- name: Install Dependencies
|
|
env:
|
|
BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
run: bun install --frozen-lockfile
|
|
```
|
|
|
|
### Override download url
|
|
|
|
If you need to override the download URL, you can use the `bun-download-url` input.
|
|
|
|
```yaml
|
|
- uses: oven-sh/setup-bun
|
|
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](https://github.com/actions/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` |
|
|
| `bun-version-file` | The version of Bun to download and install from file. | `undefined` | `.bumrc` |
|
|
| `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 |
|
|
| -------------- | ------------------------------------------ | ---------------- |
|
|
| `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` |
|