Add script for tag porting when migrating libraries into the core monorepo

[MajorLift]

Motivation

When migrating libraries into core, the tags need to be ported and renamed to fit the core repo release tag naming scheme:

• v[major].[minor].[patch] for core repo releases
• @metamask/<package-name>@[major].[minor].[patch] for package releases.

However, the migration process entails rewriting the git history of the original repo, which changes all of the commit hashes.

So in order to port tags attached to release commits from the original repo to core, we need a script to automate the process of finding the release commits from the migrated/rewritten git history, and recreating + renaming + attaching the corresponding tags.

Instructions

migrate-tags.md

Feature Checklist

• The script accepts five arguments: one required, the rest named and optional (see migrate-tags.md > B. Options).
• Extracts corresponding pairs of release version number and release commit hash from the migrated git history in merged-packages/<package-name>.
• Prepends @metamask/<package-name>@ to the version numbers.
  • Correctly handles renamed packages with at most two different package names.
• Creates package name-prepended tags on the release commits using the git tag <package-name> [commit hash] command.
• Pushes created tags to the remote repo using the git push <remote-repo> [tag-name] command.
• Tested on fork of core.
• Make dry-run mode the default. -non-dry-run flag required for tags to be created and pushed.
• Document instructions for using this script in comments and the migration process guide.

Status

Successfully tested on fork of core:

• Full list of json-rpc-engine, json-rpc-middleware-stream, eth-json-rpc-provider tags: https://github.com/MajorLift/metamask-core/tags
• Tag diff for json-rpc-engine before and after rename (6.1.0 vs. 7.0.0):
  https://github.com/MajorLift/metamask-core/compare/[email protected]...@metamask/[email protected]
• Tag diff between two most recent json-rpc-middleware-stream tags:
  https://github.com/MajorLift/metamask-core/compare/[email protected]@5.0.1

References

• Closes Add script for tag porting when migrating libraries into the core monorepo #1800
• See Fully migrate eth-json-rpc-provider into core monorepo  #1551 (comment) for an outline of the migration process.
• See Migrate libraries into core monorepo #1079 (comment) for instructions on migrating the git history of the original repo.

Changelog

N/A. No end user-facing changes.

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[mcmire]

@MajorLift Just a reminder here that when testing out this script, it would be better to test this out on a fork of core rather than core itself, so that you have a copy that you can safely blow and recreate if you need to, etc.

[MajorLift]

Yes absolutely. I won't push any tags to core with the script while it's in development.

[MajorLift]

Note: json-rpc-engine has a large number of earlier release commits that weren't tagged in the original repo. I think discovering untagged release commits should be considered out-of-scope for this script.

We could manually create any omitted tags in the original repo as a preparation step before the migration.

[mcmire]

We could manually create any omitted tags in the original repo as a preparation step before the migration.

Sure. We could also create them in this repo after migration. If some links in the changelog were already broken before the migration, then it's not a huge deal if they're still broken afterward (as long as we fix them at some point, of course).

[mcmire]

This is getting close! Just one more thing.

[mcmire]

Thanks for your patience and working through all my comments on this PR! This looks good to me now.