Improve preview build instructions for Yarn v3 #1481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gudahtt
commented
Jul 11, 2023
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 11, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
8 tasks
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 11, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
force-pushed
the
improve-yarn-v3-preview-build-setup-instructions
branch
from
cdc18c8
to
50ea6e1
Compare
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 11, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 11, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 11, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
The preview build Yarn v3 instructions have been updated to suggest a new workflow that no longer requires users to make changes to `.yarnrc.yml` without committing them. The new workflow lets users enable/disable preview builds with one environment variable, and lets them setup authentication with another. This workflow avoids the risk of users accidentally committing secrets. It's also easier to setup in CI. This workflow was inspired by the process documented in the snaps monorepo. A tip about using the macOS keychain was also ported directly from that documentation.
Gudahtt
force-pushed
the
improve-yarn-v3-preview-build-setup-instructions
branch
from
846e888
to
9d88af2
Compare
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 12, 2023
Preview builds were setup to install correctly on CircleCI prior to the Yarn v3 upgrade, but that integration broke with that upgrade. The Yarn and CircleCI configuration has been updated to fix this. The `.yarnrc.yaml` file has been updated to configure the GitHub registry but leave it disabled by default. It can be enabled dynamically using an environment variable. This lets us switch between registries without updating the file. The new workflow is documented here: MetaMask/core#1481
Gudahtt
force-pushed
the
improve-yarn-v3-preview-build-setup-instructions
branch
from
335daed
to
ee6b467
Compare
mcmire
previously approved these changes
Jul 13, 2023
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
mcmire
approved these changes
Jul 13, 2023
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
* Improve preview build instructions for Yarn v3 The preview build Yarn v3 instructions have been updated to suggest a new workflow that no longer requires users to make changes to `.yarnrc.yml` without committing them. The new workflow lets users enable/disable preview builds with one environment variable, and lets them setup authentication with another. This workflow avoids the risk of users accidentally committing secrets. It's also easier to setup in CI. This workflow was inspired by the process documented in the snaps monorepo. A tip about using the macOS keychain was also ported directly from that documentation. * Recommend setting the registry inline * Simplify preview build instructions * Improve description of shell command example Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com> --------- Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
* Improve preview build instructions for Yarn v3 The preview build Yarn v3 instructions have been updated to suggest a new workflow that no longer requires users to make changes to `.yarnrc.yml` without committing them. The new workflow lets users enable/disable preview builds with one environment variable, and lets them setup authentication with another. This workflow avoids the risk of users accidentally committing secrets. It's also easier to setup in CI. This workflow was inspired by the process documented in the snaps monorepo. A tip about using the macOS keychain was also ported directly from that documentation. * Recommend setting the registry inline * Simplify preview build instructions * Improve description of shell command example Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com> --------- Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
The preview build Yarn v3 instructions have been updated to suggest a new workflow that no longer requires users to make changes to
.yarnrc.ymlwithout committing them. The new workflow lets users enable/disable preview builds with one environment variable, and lets them setup authentication with another.This workflow avoids the risk of users accidentally committing secrets. It's also easier to setup in CI.
This workflow was inspired by the process documented in the snaps monorepo. A tip about using the macOS keychain was also ported directly from that documentation.
Additionally, documentation has been reorganized so that the "MetaMask contributor" and "independent contributor" instructions only differ for publishing (the steps for using preview builds are the same for both). Separating the instructions for publishing preview builds v.s. using them seemed to make more sense to me anyway.
Changelog
N/A, documentation only
Checklist