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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you hate `git submodule`, then you may want to give `git subtree` a try.
Let’s say you already have a git repository with at least one commit. You can add another repository into this respository like this:
## Background
When you want to use a subtree, you add the subtree to an existing repository where the subtree is a reference to another repository url and branch/tag. This `add` command adds all the code and files into the main repository locally; it's not just a reference to a remote repo.
When you stage and commit files for the main repo, it will add all of the remote files in the same operation. The subtree checkout will pull all the files in one pass, so there is no need to try and connect to another repo to get the portion of subtree files, because they were already included in the main repo.
## Adding a subtree
Let's say you already have a git repository with at least one commit. You can add another repository into this respository like this:
1. Specify you want to add a subtree
2. Specify the prefix local directory into which you want to pull the subtree
3. Specify the remote repository URL [*of the subtree being pulled in*]
4. Specify the remote branch [*of the subtree being pulled in*]
5. Specify you want to squash all the remote repository’s [*the subtree's*] logs
5. Specify you want to squash all the remote repository's [*the subtree's*] logs
#### Updating / Pushing to the subtree remote repository
## Updating / Pushing to the subtree remote repository
If you make a change to anything in `subtreeDirectory` the commit will be stored in the **host repository** and its logs. That is the biggest change from submodules.
If you now want to update the subtree remote repository with that commit, you must run the same command, excluding `--squash` and replacing `pull` for `push`.
* You can’t easily list the subtrees in your project
* You can’t, at least easily, list the remote repositories of the subtrees
* It isn't readily apparent that part of the main repo is built from a subtree
* You can't easily list the subtrees in your project
* You can't, at least easily, list the remote repositories of the subtrees
* The logs are slightly confusing when you update the host repository with subtree commits, then push the subtree to its host, and then pull the subtree.
Other than that, they’re looking nicer than submodules.
Other than that, they're looking nicer than submodules.
*[Amended from original article](https://newfivefour.com/git-subtree-basics.html)*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#### Updating / Pushing to the subtree remote repository
If you make a change to anything in `subtreeDirectory` the commit will be stored in the **host repository** and its logs. That is the biggest change from submodules.
If you now want to update the subtree remote repository with that commit, you must run the same command, excluding `--squash` and replacing `pull` for `push`.
* You can’t easily list the subtrees in your project
* You can’t, at least easily, list the remote repositories of the subtrees
* The logs are slightly confusing when you update the host repository with subtree commits, then push the subtree to its host, and then pull the subtree.
Other than that, they’re looking nicer than submodules.
*[Amended from original article](https://newfivefour.com/git-subtree-basics.html)*