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.

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

Conversation

Mrtenz
Copy link
Member

@Mrtenz Mrtenz commented Apr 5, 2023

Description

This pull request adds a warning message in the README file to caution users against the potential problems they might face when installing non-preview @metamask/-scoped packages while using preview builds.

This is copied from MetaMask/core, thanks to @Gudahtt.

Changes

  1. Added a warning message for non-preview package installation in the README file.

@Mrtenz Mrtenz requested a review from a team as a code owner April 5, 2023 16:50
@codecov
Copy link

codecov bot commented Apr 5, 2023

Codecov Report

Merging #1332 (9abeef4) into main (bc52d98) will not change coverage.
The diff coverage is n/a.

❗ Current head 9abeef4 differs from pull request most recent head bf08f3e. Consider uploading reports for the commit bf08f3e to get more accurate results

@@           Coverage Diff           @@
##             main    #1332   +/-   ##
=======================================
  Coverage   96.17%   96.17%           
=======================================
  Files         149      149           
  Lines        4549     4549           
  Branches      745      745           
=======================================
  Hits         4375     4375           
  Misses        174      174           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@Mrtenz Mrtenz force-pushed the mrtenz/preview-builds-warning branch from 9abeef4 to 25a51fc Compare April 11, 2023 10:13
Warn the potential problem when installing non-preview `@metamask/`-scoped packages while using preview builds. Users can solve this by removing the `.npmrc` / `.yarnrc.yml` changes to install the missing packages and restoring the preview build credentials afterward. For more detail, check [issue #1075](MetaMask/core#1075).
Changed "you can workaround the problem" to "you can work around the problem".
@Mrtenz Mrtenz force-pushed the mrtenz/preview-builds-warning branch from 25a51fc to bf08f3e Compare April 11, 2023 16:33
@ritave
Copy link
Member

ritave commented Apr 11, 2023

@Gudahtt says he hasn't found a way to fix the problem, but is it possible to make a yarn plugin to detect the failure state and show an error message pointing to the GitHub issue?

@hmalik88 hmalik88 merged commit 614c0e9 into main Jun 15, 2023
@hmalik88 hmalik88 deleted the mrtenz/preview-builds-warning branch June 15, 2023 11:31
GuillaumeRx pushed a commit that referenced this pull request Jun 22, 2023
…review builds (#1332)

* Add warning for non-preview package installation in README

Warn the potential problem when installing non-preview `@metamask/`-scoped packages while using preview builds. Users can solve this by removing the `.npmrc` / `.yarnrc.yml` changes to install the missing packages and restoring the preview build credentials afterward. For more detail, check [issue #1075](MetaMask/core#1075).

* Fix typo in README.md

Changed "you can workaround the problem" to "you can work around the problem".

---------

Co-authored-by: Frederik Bolding <frederik.bolding@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants