Skip to content
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

Jump to bottom

feat: add docs for private registry #470

Merged
merged 1 commit into from
Jun 3, 2024
Merged

feat: add docs for private registry #470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 20 additions & 4 deletions docs/03-github/03-test-runner.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,22 @@ Example of use:

That is all you need to test your project.

## Testing Projects with a private scoped registry

If your project has dependencies that are hosted in a private UPM registry, then you will need to
supply a valid authentication token and URL for your registry as an environment variable.

```yaml
- uses: game-ci/unity-test-runner@v4
env:
UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
UPM_REGISTRY_TOKEN: ${{ secrets.UPM_REGISTRY_TOKEN }}
with:
scopedRegistryUrl: https://example.com/registry
```

## Testing Unity packages

The test runner offers basic support for testing Unity packages, with [a few caveats](#caveats).
Expand Down Expand Up @@ -111,10 +127,10 @@ depedencies can be resolved.

#### Authentication with a private scoped registry

If your package has dependencies that are hosted in a private UPM registry, then you will need to
supply a valid authentication token for your registry as an environment variable. Setup the
[`scopedRegistryUrl`](#scopedRegistryUrl) and [`registryScopes`](#registryScopes) as usual, but also
include a `UPM_REGISTRY_TOKEN` when defining your Unity License.
If your package has dependencies that are hosted in a private UPM registry, then testing it is
similar to tesing a project. Setup the [`scopedRegistryUrl`](#scopedRegistryUrl) and
[`registryScopes`](#registryScopes) as usual, but also include a `UPM_REGISTRY_TOKEN` when defining
your Unity License.

```yaml
- uses: game-ci/unity-test-runner@v4
Expand Down
Loading