You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Fully migrate eth-json-rpc-provider into core monorepo #1551
<table><tr><td><palign="center"><b>⚠️ PLEASE READ ⚠️</b></p><palign="center">This package is currently being migrated to our <ahref="https://github.com/MetaMask/core"><code>core</code></a> monorepo. Please do not make any commits to this repository while this migration is taking place, as they will not be transferred over. Also, please re-open PRs that are under active development in the core repo.</p></td></tr></table>
2. Disable dependabot dependency upgrades.
3. Add source repo to ZenHub workspace repo filter so that issues/PRs show up on the board.
4. Align TypeScript, ESLint, Prettier dependency versions and configurations with the core monorepo.
MUST NOT rebase the migrate-<package-name> branch.
Ensure that superfluous merge commits don't pollute the history. If necessary, replace the PR branch with a cleaned-up post-migration commit history by rerunning the git history migration steps before merging the PR.
Port the tags locally with the correct package name prefixes.
Push the ported tags to a fork of the core monorepo for testing.
Verify that the tag diff links in CHANGELOG are working.
The diff between last tag before migration and first one after will always include the entire history of the monorepo.
TODO: The correct diff can be derived using git log --ancestry-path. If GitHub starts supporting compare links that use --ancestry-path, the broken diff link in the changelog should be fixed.
Push the ported tags to the core repo.
Verify that the tag diff links in CHANGELOG are working.
Identify and create tags for release commits that were untagged in the original repo.
2. Remove files and directories that will be replaced by files in the monorepo root.
Update tsconfig*.json, typedoc.json, jest.config.js to extend from corresponding files in root. Copy contents of corresponding files in other non-root packages.
Keep TypeScript compiler flags and compilation target.
Add tsconfig reference paths for non-root packages that are upstream dependencies of the migration target.
Keep Jest coverage threshold values.
Add deepmerge as a devDependency.
4. Align dependencies and build scripts with monorepo.
Remove redundant build scripts that are already listed in the root package.json (including prepack)
Identify validator fixes for CHANGELOG by navigating to merged-packages/<package-name>, running ../../scripts/validate-changelog.sh @metamask/<package-name>, and applying the diffs.
If the package has been renamed or needs to be renamed with the @metamask/ namespace, supply two arguments: versionBeforePackageRename, tagPrefixBeforePackageRename.
For open PRs in the source repo, lock conversation (with no reason provided), and leave a comment requesting that authors reopen the PR in core with a link pointing to the discussion in the original PR.
For important PRs, manually migrate into core or create tickets for follow-up.
This library has now been migrated into the [core monorepo](https://github.com/metamask/core/). This PR has been locked and this repo will be archived shortly. Going forward, releases of this library will only include changes made in the core repo.
- Please push this branch to core and open a new PR there.
- Optionally, add a link pointing to the discussion in this PR to provide context.
Leave a note in the source repo's README announcing the migration and pointing to core.
<table><tr><td><p align="center"><b>⚠️ PLEASE READ ⚠️</b></p><p align="center">This package has been migrated to our <a href="https://github.com/MetaMask/core"><code>core</code></a> monorepo, and this repository has been archived. Please note that all future development and feature releases will take place in the <a href="https://github.com/MetaMask/core"><code>core</code></a> repository.</p></td></tr></table>
Sunset GitHub Pages docs and leave link pointing to migrated docs in core.
Archive the source repo to prevent any changes from being pushed to it going forward.
Core
Add migration target to README dependency graph using the generate-dependency-graph build script.
Fix downstream errors that were marked with @ts-expect-error TODO: during the migration process.
Use the yarn create-release-branch tool to publish a release of core with a new version for the migrated package and any updated downstream packages.
Record any changes made to packages during the migration process in their respective CHANGELOGs.
changed the title [-]Migrate eth-json-rpc-provider libraries into core monorepo [/-][+]Migrate eth-json-rpc-provider library into core monorepo [/+]on Oct 20, 2023
changed the title [-]Migrate eth-json-rpc-provider library into core monorepo [/-][+]Migrate `eth-json-rpc-provider` library into core monorepo [/+]on Oct 20, 2023
changed the title [-]Migrate `eth-json-rpc-provider` library into core monorepo [/-][+]Fully migrate `eth-json-rpc-provider` into core monorepo [/+]on Oct 20, 2023
Activity
Align ESLint, Prettier packages and configs with core monorepo ahead …
Align ESLint, Prettier packages and configs with core monorepo ahead …
Migrate `eth-json-rpc-provider` into core monorepo (1/2) (#1737)
MajorLift commentedon Oct 3, 2023
Migration Checklist
Phase A: Preparation in source repo
1. Add migration notice to README
2. Disable
dependabotdependency upgrades.3. Add source repo to ZenHub workspace repo filter so that issues/PRs show up on the board.
4. Align TypeScript, ESLint, Prettier dependency versions and configurations with the core monorepo.
5. Add any missing files required in subpackages of the core monorepo (e.g. LICENSE).
6. If the package name is not prefixed by the
@metamask/namespace, rename the package.package.json.7. Create a new release of the migration target from the source repo
Phase B: Staging from
merged-packages/0. Move the migration target into a temporary directory in core (
merged-packages/).migrate-<package-name>branch.1. Port tags
git log --ancestry-path. If GitHub starts supporting compare links that use--ancestry-path, the broken diff link in the changelog should be fixed.2. Remove files and directories that will be replaced by files in the monorepo root.
eth-json-rpc-providermigration - B1: Remove redundant files and directories. #1764.github/,.git*,scripts/,.depcheckrc.json,.yarn/,.yarnrc.yml,yarn.lock,.editorconfig,.eslint*,.prettier*,.nvm*.src/,tests/,CHANGELOG.md,LICENSE,package.json,README.md,jest.config.js,tsconfig*.json,typedoc.json.3. Replace config files.
eth-json-rpc-providermigration - B2: Replace typescript, jest config files. #1765tsconfig*.json,typedoc.json,jest.config.jsto extend from corresponding files in root. Copy contents of corresponding files in other non-root packages.deepmergeas a devDependency.4. Align dependencies and build scripts with monorepo.
eth-json-rpc-providermigration - B3: Align dependencies with monorepo. #1766prepack)merged-packages/<package-name>, running../../scripts/validate-changelog.sh @metamask/<package-name>, and applying the diffs.@metamask/namespace, supply two arguments:versionBeforePackageRename,tagPrefixBeforePackageRename.5. Add exception for non-MIT license.
constraints.profile.constraints.pro: Exclude (\=) from MIT rule and include in ISC rule (==)yarn constraints.6. Update README
Phase C: Integration into
packages/eth-json-rpc-providermigration - Integration intopackages/#17381. The big leap
merged-packages/topackages/.yarn installin the root directory.yarn workspace @metamask/<package-name> test.2. Update downstream repos
tsconfig.jsonandtsconfig.build.jsonfiles.eth-json-rpc-providermigration - Integration intopackages/#1738 (comment)3. Linter fixes
yarn constraints --fix(run twice).changelog:validatebuild script.4. Resolve or TODO downstream errors
@ts-expect-error TODO:annotations.NetworkControllerand its downstream packages #18235. Finalize merge
packages/<package-name>directory into core main branch.Phase D: Release and Clean-up
Source repo
Transfer issuefeature.Blocked by Explore solutions for transferring issues and PRs from other repos into the core monorepo #1835Sunset GitHub Pages docs and leave link pointing to migrated docs in core.Core
generate-dependency-graphbuild script.@ts-expect-error TODO:during the migration process.yarn create-release-branchtool to publish a release of core with a new version for the migrated package and any updated downstream packages.`eth-json-rpc-provider` migration - B3: Align dependencies with monor…
`eth-json-rpc-provider` migration - B4: Add exceptions in `constraint…
`eth-json-rpc-provider` migration - B1: Remove redundant files and di…
`eth-json-rpc-provider` migration - B2: Replace typescript, jest conf…
6 remaining items
Remove files and directories that will be replaced by files in the mo… (
[-]Migrate eth-json-rpc-provider libraries into core monorepo [/-][+]Migrate eth-json-rpc-provider library into core monorepo [/+][-]Migrate eth-json-rpc-provider library into core monorepo [/-][+]Migrate `eth-json-rpc-provider` library into core monorepo [/+][-]Migrate `eth-json-rpc-provider` library into core monorepo [/-][+]Fully migrate `eth-json-rpc-provider` into core monorepo [/+]Update `@metamask/json-rpc-engine` README to reflect migration into m…
Add `json-rpc-middleware-stream` to root `tsconfig` files (#2013)
eslintandprettier#1683~4.6.3#1682@metamask/eth-json-rpc-provider- Phase B: Staging frommerged-packages/#1792@metamask/eth-json-rpc-providerto core monorepo #1685@metamask/eth-json-rpc-provider#1842