A page to warn users about a suspected phishing site. This is used as part of the MetaMask extension.
This package is published to npm so that we can host it locally when running end-to-end tests. This is not intended to be used as a library.
nvm use
will automatically choose the right node version for you.yarn install
to install dependencies and run any required post-install scriptsRun yarn lint
to run the linter, or run yarn lint:fix
to run the linter and fix any automatically fixable issues.
Before running tests using Playright, you will need to install the required browsers using yarn playwright install [space-separated browsers]
. Use the --with-deps
flag as well to prompt Playwright to install OS dependencies as well if possible, though be warned that this may require elevated privileges.
The browsers we test with in CI are chrome
, chromium
, firefox
, and msedge
.
To install all browsers we use on CI and any OS dependencies, run:
yarn playwright install --with-deps chrome chromium firefox msedge
You may want to consider using just one or two browsers for local testing to speed things up. These install steps are long and require a decent amount of disk space.
Tests can be run using yarn test
. This will run all tests using all browsers.
To run with just a single browser, you'll need to use the flag --project=[browser name]
. For example, yarn test --project=chromium
to run all tests with Chromium. See the Playwright configuration (playwright.config.ts
) to see the other project names.
If you want to run a single test suite, pass in the test filename as a parameter. For example, yarn test ./tests/defaults.spec.ts
will run just the "defaults" test suite.
The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions action-create-release-pr
and action-publish-release
are used to automate the release process; see those repositories for more information about how they work.
Choose a release version.
If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x
for a v1
backport release).
v1.0.2
release, you'd want to ensure there was a 1.x
branch that was set to the v1.0.1
tag.Trigger the workflow_dispatch
event manually for the Create Release Pull Request
action to create the release PR.
action-create-release-pr
workflow to create the release PR.Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
yarn auto-changelog validate --rc
to check that the changelog is correctly formatted.Review and QA the release.
Squash & Merge the release.
action-publish-release
workflow to tag the final release commit and publish the release on GitHub.Publish the release on npm.
npm publish --dry-run
to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using https://unpkg.com/browse/[package name]@[package version]/
).npm publish
.