Skip to content

feat: multiple upstreams #397

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
merged 14 commits into from
Sep 21, 2024
Merged

feat: multiple upstreams #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c2dcc7f
refactor: rename symbols
Sep 15, 2024
f1ead8d
refactor: variable init
Sep 15, 2024
6c9c700
extract functions
Sep 15, 2024
7b55e44
simplify
Sep 15, 2024
d0dbccf
extract function
Sep 15, 2024
6defe99
fix
Sep 15, 2024
2626a6c
simplify
Sep 15, 2024
2633807
return source
Sep 15, 2024
dba581c
use n sources
Sep 15, 2024
655576a
drop variable
Sep 15, 2024
0035643
improve test
Sep 15, 2024
3f880c6
fix scope logic
Sep 15, 2024
0e21feb
make registry multi arg
Sep 17, 2024
cbe9d06
docs: expand registry readme section
Sep 21, 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
44 changes: 31 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The tool is designed to work with [the OpenUPM registry](https://openupm.com), b
- [Authenticate for the Windows system user](#authenticate-for-the-windows-system-user)
- [Troubleshooting](#troubleshooting)
- [Command options](#command-options)
- [Work with Unity official (upstream) registry](#work-with-unity-official-upstream-registry)
- [Work with different registries](#work-with-different-registries)
- [Work with proxy](#work-with-proxy)
- [Contributors](#contributors)

Expand Down Expand Up @@ -240,22 +240,40 @@ Show verbose logging
openupm --verbose ...
```

## Work with Unity official (upstream) registry
## Work with different registries

Most commands can fall back to Unity upstream registry if necessary, to make it easier to mix the official registry with a 3rd-party registry. i.e.
By default the openupm will query any package from the following registries:

```
$ openupm add com.unity.addressables com.littlebigfun.addressable-importer
added: com.unity.addressables@1.4.0 # from unity registry
added: com.littlebigfun.addressable-importer@0.4.1 # from openupm registry
...
```
1. Openupm (https://package.openupm.com)
2. Unity (https://packages.unity.com)

Turn off Unity official (upstream) registry
Any package will be searched on these registries in the order that they are listed above. If you want to install packages from your own third party registries you can do this via the `--registry` option.

```
openupm --no-upstream ...
```
```openupm --registry https://package.my-registry.com add com.my.package```

This will query the following registries:

1. The private registry (https://package.my-registry.com)
2. Unity (https://packages.unity.com)

Let's say `com.my.package` depends on a Openupm package. With the above configuration the install would fail because Openupm is not part of the queried registries. To fix, add Openupm to the --registry option.

```openupm --registry https://package.my-registry.com https://package.openupm.com add com.my.package```

The query will now look like this:

1. The private registry (https://package.my-registry.com)
2. Openupm (https://package.openupm.com)
3. Unity (https://packages.unity.com)

Finally, it may not always be desirable to search the Unity registry. If you want to remove it from the registry list, run with the `--no-upstream` option.

```openupm --registry https://package.my-registry.com https://package.openupm.com --no-upstream add com.my.package```

The resulting query is:

1. The private registry (https://package.my-registry.com)
2. Openupm (https://package.openupm.com)

## Work with proxy

Expand Down
Loading