Skip to content

local-builds.md

Latest commit

 

History

History
40 lines (32 loc) · 1.35 KB

local-builds.md

File metadata and controls

40 lines (32 loc) · 1.35 KB

Using local builds

If you are unable to use preview builds for testing, you can always build a package locally and link it to a project.

  1. First, build the monorepo by running yarn build.

  2. In the project, open package.json and locate the entry in dependencies for the package you want to test.

  3. Replace the version range in the right-hand side of the entry to point to the local build:

    "@metamask/<PACKAGE_NAME>@<VERSION_RANGE>": "file:<PATH_TO_CORE>/packages/<PACKAGE_NAME>"

    where:

    • PACKAGE_NAME is the name of your package
    • VERSION_RANGE is the version range of your package being used in production, usually starting with ^
    • PATH_TO_MONOREPO is the local path to the clone of this monorepo

  4. Run yarn install. (Note that due to the use of Yarn's file: protocol, you'll need to repeat this step each time you update the package in the monorepo.)

Example:

Given:

  • You have changes to @metamask/controller-utils you want to test
  • @metamask/controller-utils is listed at ^1.1.4
  • You've cloned this repo next to the project

In this case, you would go to dependencies and replace the line:

"@metamask/controller-utils": "^1.1.4"

with:

"@metamask/controller-utils@^1.1.4": "file:../core/packages/controller-utils"