Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xhyrom merged 2 commits into from
Jun 24, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7acf7d2
docs: .bun-version
xhyrom Jun 24, 2024
ecf3369
docs: correct bun-version-file examples
xhyrom Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down