From 5d6c793f63250269ba7e4539db1f468c603d9d06 Mon Sep 17 00:00:00 2001 From: Mark Stacey Date: Wed, 5 Apr 2023 12:31:37 -0230 Subject: [PATCH 1/2] Add warning to preview build documentation A warning has been added to the preview build documentation about a known problem with that workflow. The warning explains the workaround for the problem. --- docs/contributing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index 19594c7d4c9..db01f122d97 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -21,6 +21,14 @@ 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 workaround 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: From 08b4a3057898ea14c510efa3fff40c97152f4e30 Mon Sep 17 00:00:00 2001 From: Mark Stacey Date: Wed, 5 Apr 2023 14:18:43 -0230 Subject: [PATCH 2/2] Fix grammar Co-authored-by: Maarten Zuidhoorn --- docs/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index db01f122d97..f807a89526b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -25,7 +25,7 @@ When developing changes to packages within this repository that a different proj > > 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 workaround 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. +> 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.