migrate: switch to git-filter-repo, make temp dir creation more robust, enable changing default branch name

[rikkit]

Hey there, I'm currently using meta to restructure a monorepo I work on, and I've made these changes to meta-project-migrate:

• switch to git filter-repo instead of git filter-branch because it's been deprecated https://git-scm.com/docs/git-filter-branch#_warning (requires separate install)
• use Node's mkdtempSync function to get a temp folder in /usr/tmp instead of making one inside the repo - filter-repo won't work otherwise
• pass the branch argument to splitSubtree so that we can use main instead of master Allow use of main as primary branch in edge cases like migrate meta#281
• read the value of defaultBranch if available so that main can be set on a project level

I'm not finished migrating the repo yet - I need to make some more changes to make other meta commands read the defaultBranch option. I've opened this PR now for early feedback since I'm not sure how you would like to review these changes, or if you'd like to accept them all, so let me know and I can split up this PR if needed.

[patrickleet]

@rikkit

Sorry hadn't seen this before now - usually have an average of 500 notifications lol

I added this migrate command originally - and it worked for my purpose

Is this draft working at least?

[rikkit]

Hey, yeah I successfully migrated a couple of projects with the code in here. The two things that were a problem for me with the existing command were

1. the performance of git filter-repo. Switching to filter-branch means this now takes seconds to migrate
2. using main instead of master.

[patrickleet]

the performance of git filter-repo. Switching to filter-branch means this now takes seconds to migrate

Think you said this backwards? 7564b76#diff-b45341acb11c77181833b113debfc339b0893c889afb46121cb1d12c0c0e36d8R5

Anyway, this looks good to me. Performance improvements are always welcome. I'll try it locally.

Thanks!

[rikkit]

Think you said this backwards?

Yep, sorry, got confused!

[patrickleet]

Hi @rikkit

sorry took me a few weeks to get to this...

so, I didn't realize that git filter-repo isn't a standard git command

Using this with filter-repo would require users to install additional tools vs the built in filter-branch

Or am I missing something?

(using git 2.36)

[patrickleet]

though once installed the migrate command does appear to work

I still see a temp folder that wasn't cleaned up though:

[patrickleet]

https://github.com/patrickleet/migrate-test
https://github.com/patrickleet/migrate-test-a
https://github.com/patrickleet/migrate-test-b

[patrickleet]

oh I think the tmp directory was from the first run where I didn't have filter-repo installed yet, so nevermind on that one

[patrickleet]

defaultBranch in .meta config works fine though - used main for this test

I guess the only issue is the separate install - hm - I suppose just checking for it and logging an error telling the user to install it would be ok?

[patrickleet]

@rikkit @mateodelnorte ^

[rikkit]

Hey @patrickleet, thanks for the review and glad it all worked.

I think there are two approaches to take depending on how strongly you feel about it. One checking for it and logging some info on how to install. Two, supporting both versions and falling back to filter-branch if filter-repo is not available.

I feel like approach one is reasonable given that Git have deprecated the command. Plus it's less to maintain in this project.

How should we take this forward?

[patrickleet]

@rikkit haven't merged it yet, but also added a couple lines yesterday in meta init that will set defaultBranch in the .meta file when you first run it

[patrickleet]

@rikkit also it's bothered me ever since I made it that I put the folder name before the repo url. I think the other way around would have been better.

Kinda thinking maybe we go with both for now - just change the name of the old command, and add the new one as well using the "migrate" command name (what to put for deprecated one? migrate-classic or something?)

I think the logs should link to instructions of how to install filter-repo for using this version though, regardless, and if you want to use a slower version without installing anything, use migrate-classic. Thoughts?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[rikkit]

Hey @patrickleet , sorry for the gigantic delay in replying.

Is it possible to specify versions for plugins of meta? Would it work if someone for example just use an older version of meta-project if they want the old behaviour? Maybe by doing npm i -g meta-project@x.x.x. Then the new command can simply print a log message suggesting what to do.

[patrickleet]

I tried this and it worked, the only real hangup I had was the requirement to install an extra tool and I wasn't really sure about the best thing to do there