@wpelevator/subtree-split
v0.2.3
Published
Split the history of a directory into its own commits, with the same commit hashes as git subtree split
Readme
subtree-split
Split a directory of a monorepo into its own history, with the same commit hashes as git subtree split, in about a tenth of a second instead of several seconds.
In a monorepo with 477 commits, git subtree split takes 6 to 8 seconds for one package and subtree-split takes 0.1 seconds. On WordPress/gutenberg (43,568 commits) it splits packages/components in 1.7 seconds. The hashes are the same as git subtree split makes, so a repository that you already split that way keeps its history when you switch.
@wpelevator/wp-release uses it for deploy git --split-prefix.
The detailed documentation lives in this package's docs/ directory. The monorepo docs site builds it for wpelevator.github.io/docs/js/subtree-split/latest/ and includes released versions whose tags contain docs.
Quick start
Run it in the monorepo, with the directory that you want to split:
npx @wpelevator/subtree-split --prefix packages/my-libraryIt prints the hash of the split commit and writes the commits to the repository. It doesn't change a branch, so you decide what to do with the hash. To publish it to the repository of the package:
tip=$(npx @wpelevator/subtree-split --prefix packages/my-library)
git push [email protected]:acme/my-library.git "$tip:refs/heads/main"To keep it in a local branch instead, run git update-ref refs/heads/split/my-library "$tip".
It needs Node.js 22.12 or later, Git 2.29 or later, and the full history of the repository. It works in a bare clone, and it fails with a message on a shallow one, so in CI check out with fetch-depth: 0.
See the CLI page for the options, GitHub Actions for workflows, caching to speed up repeated runs, the library API for JavaScript, and compatibility for the limits and how the hashes match git subtree split.
Develop
See development.
License
MIT
