From 3fcae870de13a844dae12ec19e0c3554d9bf4928 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jozef=20Steinh=C3=BCbl?= Date: Mon, 24 Jun 2024 15:15:35 +0200 Subject: [PATCH] docs: show correct bun-version-file examples (#86) * docs: .bun-version * docs: correct bun-version-file examples --- README.md | 16 ++++++++-------- action.yml | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 303b9876..186ef137 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/action.yml b/action.yml index 22ec0bca..45646333 100644 --- a/action.yml +++ b/action.yml @@ -9,7 +9,7 @@ inputs: description: 'The version of Bun to install. (e.g. "latest", "canary", "1.0.0", "1.0.x", )' 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: