feat: support for multiple registries (#109)

* feat: support for multiple registries * [autofix.ci] apply automated fixes * refactor: drop unnecessary check * fix: pass empty array instead undefined * [autofix.ci] apply automated fixes * fix: dont add registry set line * [autofix.ci] apply automated fixes * feat: few more tests * feat: add bun types * docs: explain registries * feat: save globally * [autofix.ci] apply automated fixes * ci: jsr registry test * ci: add , * ci: test * ci: test * ci: test * ci: test * [autofix.ci] apply automated fixes * feat: use @iarna/toml * [autofix.ci] apply automated fixes * feat: registry parsing * [autofix.ci] apply automated fixes * ci: verbose add * ci: registry install check * ci: registry install check * ci: registry install check * ci: verify registry usage * docs: registries * docs: important block * docs: show table * docs: show table * ci: shell * ci: registry test on linux * ci: registry test on linux * build: text lockfile --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-07-09 12:22:12 +02:00
parent 7c641390eb
commit 34f777aec1
14 changed files with 901 additions and 117 deletions
--- a/README.md
+++ b/README.md
@@ -18,24 +18,42 @@ Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
    bun-version-file: ".bun-version"
 ```

-### Using a custom NPM registry
+## Using custom registries
+
+You can configure multiple package registries using the `registries` input. This supports both default and scoped registries with various authentication methods.
+
+### Registry configuration

 ```yaml
 - uses: oven-sh/setup-bun@v2
  with:
-    registry-url: "https://npm.pkg.github.com/"
-    scope: "@foo"
-```
+    registries: |
+      https://registry.npmjs.org/
+      @myorg:https://npm.pkg.github.com/|$GITHUB_TOKEN
+      @internal:https://username:$INTERNAL_PASSWORD@registry.internal.com/

-If you need to authenticate with a private registry, you can set the `BUN_AUTH_TOKEN` environment variable.
-
-```yaml
- name: Install Dependencies
+- name: Install dependencies
  env:
-    BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-  run: bun install --frozen-lockfile
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    INTERNAL_PASSWORD: ${{ secrets.INTERNAL_PASSWORD }}
+  run: bun install
 ```

+#### Registry format options
+
+| Type                                 | Format                                                    |
+| ------------------------------------ | --------------------------------------------------------- |
+| Default registry                     | `https://registry.example.com/`                           |
+| Default registry with token          | `https://registry.example.com/\|$TOKEN`                   |
+| Scoped registry                      | `@scope:https://registry.example.com/`                    |
+| Scoped registry with token           | `@scope:https://registry.example.com/\|$TOKEN`            |
+| Scoped registry with URL credentials | `@scope:https://username:$PASSWORD@registry.example.com/` |
+
+> [!IMPORTANT]
+> When using authentication, make sure to set the corresponding environment variables in your workflow steps that need access to the registries.
+
+For more information about configuring registries in Bun, see the [official documentation](https://bun.sh/docs/install/registries).
+
 ### Override download url

 If you need to override the download URL, you can use the `bun-download-url` input.