oven-sh/setup-bun
1
0
Fork 0
mirror of https://github.com/oven-sh/setup-bun.git synced 2025-02-22 17:50:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: show correct bun-version-file examples (#86)

Browse Source 
* docs: .bun-version

* docs: correct bun-version-file examples
This commit is contained in:
Jozef Steinhübl 2024-06-24 15:15:35 +02:00 committed by GitHub
parent 123c6c4e2f
commit 3fcae870de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -15,7 +15,7 @@ Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
```yaml
- uses: oven-sh/setup-bun@v2
with:
bun-version-file: ".bumrc"
bun-version-file: ".bun-version"
```
### Using a custom NPM registry
@ -52,13 +52,13 @@ In most cases, you shouldn't need to use the [setup-node](https://github.com/act
## 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"` |
| 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` | `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

2
action.yml
View File

@ -9,7 +9,7 @@ inputs:
description: 'The version of Bun to install. (e.g. "latest", "canary", "1.0.0", "1.0.x", <sha>)'
required: false
bun-version-file:
description: 'The version of Bun to install from file. (e.g. "package.json", ".bumrc", ".tool-versions")'
description: 'The version of Bun to install from file. (e.g. "package.json", ".bun-version", ".tool-versions")'
default: ".bun-version"
required: false
bun-download-url: