Add auth setup for private registry with scope (#16)

feat: add auth setup to private registry with scope
This commit is contained in:
Vitor Gomes 2023-11-01 06:17:17 -03:00 committed by GitHub
parent 6be87460e3
commit 830e319e28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 23030 additions and 3503 deletions

View file

@ -10,11 +10,31 @@ Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
bun-version: latest
```
### Setup custom registry-url and scope (for private packages)
```yaml
- uses: oven-sh/setup-bun@v1
with:
registry-url: "https://npm.pkg.github.com/"
scope: "@foo-bar"
```
After setting up the registry-url and scope, when installing step comes, inject the env to authenticate and install all packages from the private registry
```yaml
- name: Installing dependencies
env:
BUN_AUTH_TOKEN: ${{ secrets.MY_SUPER_SECRET_PAT }}
run: bun i
```
## Inputs
| Name | Description | Default | Examples |
| ------------- | ------------------------------------------- | -------- | -------------------------- |
| `bun-version` | The version of Bun to download and install. | `latest` | `canary`, `1.0.0`, `<sha>` |
| Name | Description | Default | Examples |
| -------------- | -------------------------------------------------- | ----------- | ------------------------------- |
| `bun-version` | The version of Bun to download and install. | `latest` | `canary`, `1.0.0`, `<sha>` |
| `registry-url` | Registry URL where some private package is stored. | `undefined` | `"https://npm.pkg.github.com/"` |
| `scope` | Scope for private pacakages | `undefined` | `"@foo-bar"`, `"@orgname"` |
## Outputs