How to Split a Subdirectory to a New Git Repository and Keep the History

There comes a time when you need to split out a subdirectory into it’s own git repo.

This is a very simple task if you don’t care about persisting the git history for any changes that were made in that subdirectory.

However, if you would like to keep all the history of the subdirectory only, and not of the overall entire repository itself, then you can perform the following bunch of steps:

Step 1: Clone your existing repo to a temp location

git clone https://github.com/ao/your_repo.git cd your_repo
Code language: Bash (bash)

Step 2: Checkout the branch where the subdirectory is

git checkout your_branch_name
Code language: Bash (bash)

Step 3: Run the Git Filter-Branch Command

The git filter-branch command allows you to prune empty entries and specify a subdirectory filter to base off:

git filter-branch --prune-empty --subdirectory-filter relative/path/to/subdirectory your_current_branch_name
Code language: Bash (bash)

Step 4: Update your new Git Remote

At this stage, you can go and create a new git repository, and copy the path:

git remote set-url origin https://github.com/ao/your_new_sub_repo.git
Code language: Bash (bash)

Step 5: Push your changes

You can now push your changes to your new repository:

git push -u origin your_current_branch_name
Code language: Bash (bash)

As a runnable script

git clone https://github.com/ao/your_repo.git cd your_repo git checkout your_branch_name git filter-branch --prune-empty --subdirectory-filter relative/path/to/subdirectory your_current_branch_name git remote set-url origin https://github.com/ao/your_new_sub_repo.git git push -u origin your_current_branch_name
Code language: Bash (bash)
Tags:
Subscribe
Notify of
guest
1 Comment
Newest
Oldest Most Voted
Inline Feedbacks
View all comments
Tyler mace
2 months ago

Given that the files repository might have LFS pointers to files in them, it might warrant an additional couple of steps. This is warranted even if there are no LFS-based files in your target directory but other directories.

git lfs migrate export –everything –include .                                     
git commit -a -m “Result of flattening LFS pointers to files.”

Do this step BEFORE the filter-branch step.