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

Add warning message for non-preview package installation when using preview builds #1332

Merged
merged 3 commits into from
Jun 15, 2023
Merged

Add warning message for non-preview package installation when using preview builds #1332

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ff4614
Add warning for non-preview package installation in README
Mrtenz Apr 5, 2023
bf08f3e
Fix typo in README.md
Mrtenz Apr 5, 2023
eda7d6c
Merge branch 'main' into mrtenz/preview-builds-warning
FrederikBolding Jun 15, 2023
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Repository-wide watching is currently not possible due to the build processes of

When developing changes to packages within this repository that a different project depends upon, you may wish to load those changes into the project and test them locally or in CI before publishing proper releases of those packages. To solve that problem, this repository provides a mechanism to publish "preview" versions of packages to GitHub Package Registry. These versions can then be used in the project like any other version, provided the project is configured to use that registry.

> **Warning**
>
> There is a known problem with the preview build workflow. It relies upon you having a local cache of any non-preview `@metamask/`-scoped packages.
>
> If you encounter problems installing non-preview `@metamask/`-scoped packages when using this workflow, you can work around the problem by temporarily removing the `.npmrc` / `.yarnrc.yml` changes to install the missing packages. Once they are installed, restore the preview build credentials to use preview builds. The non-preview `@metamask/`-scoped packages should then be found in your local cache.
>
> See [issue #1075](https://github.com/MetaMask/core/issues/1075) for more details.

#### As a MetaMask contributor

If you're a MetaMask contributor, you can create these preview versions via draft pull requests:
Expand Down