chore: improve install script and yarn config#12576
Merged
Conversation
1113cfa to
5aea1dd
Compare
5aea1dd to
04ddbf0
Compare
ashlsun
approved these changes
Feb 24, 2026
This file contains hidden or 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
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.
Description
Improves the reliability and maintainability of the local development install script and Yarn configuration. The install script now runs idempotently (skipping steps already completed), adds a Python virtual environment setup step, improves NVM detection and sourcing, adds section progress headers, and uses
set -euo pipefailfor safer execution. The README is updated to usesource scripts/install.shso NVM and virtual environment activations persist in the calling shell. Yarn's.yarnrc.ymlis updated with log filters to suppress known noisy warnings and package extensions to mark common optional peer dependencies.This means the install script is overall less chatty and on subsequent runs executes faster while still maintaining a reliable setup environment.
Approach
source scripts/install.sh(not./scripts/install.sh) so that NVM and the Python virtual environment are activated in the current shell session. The README has been updated to reflect this..venvPython virtual environment and installsrequirements.txton first run (or whenrequirements.txtchanges). Subsequent runs skip this step.colima startare now guarded to skip if already running.Steps to Test
source scripts/install.shon a machine where all or some dependencies are already installed.nvmand the Python virtual environment are active in the shell after sourcing, and the correct version of Node.js is available in the shell.yarn start:devto confirm the dependency changes do not break the build.Notes
command -v nvmto checking for$HOME/.nvm/nvm.shis necessary because NVM is a shell function, not a binary, and may not be onPATHwhen the script is sourced in a fresh shell context..yarnrc.ymlsuppress peer dependency warnings for packages known to have incorrect or overly strict peer dep declarations (e.g., Storybook, Decap CMS, various AWS SDK packages). This reduces noise duringyarn installwithout hiding actionable warnings.resolutionsblock for@types/reactand@types/react-domwas removed fromweb/package.jsonas it is no longer needed.resolutionsblock is defined at the root and is not needed in the subdirectories.Code author checklist
userData(includingprofileData,formationDataetc), then I added a new migration filecmsCollections.ts(see CMS Additions in Engineering Reference/FAQ on the engineering documentation site).envvalues in.env-template, in Bitwarden, and in our workspacesrequest-reviewertag on github to request reviews