Skip to content

Commit 3fcae87

Browse files
authored
docs: show correct bun-version-file examples (#86)
* docs: .bun-version * docs: correct bun-version-file examples
1 parent 123c6c4 commit 3fcae87

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
1515
```yaml
1616
- uses: oven-sh/setup-bun@v2
1717
with:
18-
bun-version-file: ".bumrc"
18+
bun-version-file: ".bun-version"
1919
```
2020
2121
### 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
5252

5353
## Inputs
5454

55-
| Name | Description | Default | Examples |
56-
| ------------------ | ----------------------------------------------------- | ----------- | ------------------------------- |
57-
| `bun-version` | The version of Bun to download and install. | `latest` | `canary`, `1.0.0`, `1.0.x` |
58-
| `bun-version-file` | The version of Bun to download and install from file. | `undefined` | `.bumrc` |
59-
| `bun-download-url` | URL to download .zip file for Bun release | | |
60-
| `registry-url` | Registry URL where some private package is stored. | `undefined` | `"https://npm.pkg.github.com/"` |
61-
| `scope` | Scope for private packages. | `undefined` | `"@foo"`, `"@orgname"` |
55+
| Name | Description | Default | Examples |
56+
| ------------------ | ----------------------------------------------------- | ----------- | ------------------------------------------------ |
57+
| `bun-version` | The version of Bun to download and install. | `latest` | `canary`, `1.0.0`, `1.0.x` |
58+
| `bun-version-file` | The version of Bun to download and install from file. | `undefined` | `package.json`, `.bun-version`, `.tool-versions` |
59+
| `bun-download-url` | URL to download .zip file for Bun release | | |
60+
| `registry-url` | Registry URL where some private package is stored. | `undefined` | `"https://npm.pkg.github.com/"` |
61+
| `scope` | Scope for private packages. | `undefined` | `"@foo"`, `"@orgname"` |
6262

6363
## Outputs
6464

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ inputs:
99
description: 'The version of Bun to install. (e.g. "latest", "canary", "1.0.0", "1.0.x", <sha>)'
1010
required: false
1111
bun-version-file:
12-
description: 'The version of Bun to install from file. (e.g. "package.json", ".bumrc", ".tool-versions")'
12+
description: 'The version of Bun to install from file. (e.g. "package.json", ".bun-version", ".tool-versions")'
1313
default: ".bun-version"
1414
required: false
1515
bun-download-url:

0 commit comments

Comments
 (0)