setup-bun/README.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

2022-07-11 10:18:22 +02:00
# setup-bun
2023-02-22 17:47:24 -08:00
Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
2022-07-11 10:18:22 +02:00
## Usage
```yaml
2023-02-22 17:47:24 -08:00
- uses: oven-sh/setup-bun@v1
2022-07-11 10:18:22 +02:00
with:
bun-version: latest
```
## Inputs
2022-07-13 09:42:54 +02:00
| Name | Description | Default | Examples |
| ------------- | ------------------------------------------- | -------- | -------------------------- |
| `bun-version` | The version of Bun to download and install. | `latest` | `canary`, `1.0.0`, `<sha>` |
## 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+822a00c4d508b54f650933a73ca5f4a3af9a7983` |