What are git submodules?
First "git submodules" have nothing to do with Drupal modules. They're a way of including one git repository inside another, in its entirety, and managing it from within the parent repository.
In a regular git repository, you have one .git directory in the root directory of the project that contains the entire history and all the revisions for that project. Every change in the project is tracked in that one .git repository.
Using git submodules you have one or more sub-repositories of the main one. They look exactly like a regular git repository, but the parent repository knows just enough about them to manipulate them.
For example, if we're using the regular Drupal checkout as our main repository and checking out Drupal modules as submodules, we might do this:
git clone git://git.drupal.org/project/drupal.git --branch 7.x git submodule add --branch 7.x-1.x git://git.drupal.org/project/examples.git sites/all/modules/examples git submodule add --branch 7.x-3.x git://git.drupal.org/project/admin_menu.git sites/all/modules/admin_menu
This would check out Examples and Admin Menu into sites/all/modules in the Drupal tree, but as real first class git repositories (they have their own .git directories), but the parent repository (the Drupal repo in this case) knows what they are and what to do about them. I can now use all the git tools I can think of in the Examples or Admin Menu directories, including pulling (to follow a tracking branch), git bisect to debug, git checkout (to get a particular tag/version). I can also create a patch after solving a problem with the regular git tools and I can apply a patch with git apply in those directories, all without thinking twice. There are lots of reasons this appeals to me.
Practical deployment with git submodules
Once we have a repository that contains submodules, we can push it to a remote, as with any git repository. Note that we're not pushing the Drupal module submodules though (as in most cases we don't even have commit privileges on them).
When building a site based on Drupal I usually do this:
Now I have a local site that's all ready to go, and has been pushed to my private repository (or github, or whatever).
I can deploy this site on a server by just cloning it and then updating the submodules. The fact that you have to do two discreet steps is in fact unfortunate and it is easy to forget after cloning or pulling. But here's the process for deploying from the new private repository that we pushed to:
Not too hard. The git submodule update --init tells the main repository to go through all the submodules listed in its .gitmodules file and initialize each one (cloning it and checking out the correct revision).
Updating the main repository and submodules
When the time comes to update a deployment (or a dev environment; they're the same), we would use this technique.
To update the main repository based on what's already on the branch we're tracking ("site"):
git pull git submodule update --init
To update the main repository to the latest Drupal version or to some specific version:
git fetch drupal # Get all the latest from drupal.org git merge 7.x # Merge the latest Drupal from the drupal.org 7.x branch git push origin site # push these new changes to our remote
To update submodules we just pull (or change branches, or check out a tag, or whatever) and then add the updated submodule to the main site repo. This example would update to the latest version of Examples, since it's set up to be tracking the origin/7.x-1.x branch:
cd sites/all/modules/examples git pull # to update the parent repository we have to get into its scope, so go up a directory cd .. git status git add examples git commit -m "Updated examples" git push origin site
Two major directory structures
I know of two major ways to organize Drupal with submodules.
- Using Drupal itself as the base repository, as I've done above. This is easy, intuitively obvious, and works beautifully with Drush.
- Creating a main repository (which includes sites/all) and then adding Drupal as a submodule, and other projects also as submodules, This allows Drupal to exist as a separate repository rather than as a container for submodules, and also allows adding other assets, etc.
The structure in this case might be:
- Master repo (containing directories named sites, assets, etc.)
- Drupal as a submodule of the master repo and located in /drupal
- Other projects as submodules of the master repo and located in the sites directory.
The great thing about this organization is that Drupal is a submodule just like everything else, and that non-Drupal assets can be added in other directories, etc.
The two drawbacks are:
- The Drupal submodule's "sites" directory must be replace with a symbolic link that points to the master repo's sites directory (usually "../sites")
- Out of the box, drush dl doesn't work with this configuration, although I still intend to figure out how to make it work.
Miscellanous Submodule Tidbits
- drush has excellent integration with git submodules, which is one reason I love submodules and the basic "use-Drupal-as-the-master-repo" technique. drush dl mymodule --package-handler=drupalorg_git --gitsubmodule will happily download "mymodule" and set it up as a submodule. Just like that. If you want drush always to work this way put these lines in your ~/.drush/drushrc.php:
$options['package-handler'] = 'git_drupalorg';
$options['gitsubmodule'] = TRUE;
- If you fork a Drupal project (if you have your own patches for it) you'll have to have your own forked repository for it, either as a sandbox on Drupal.org or in a private repository. The nice thing is that when the main module catches up to those patches, you can just change the remote on that submodule and do nothing else, and you'll be back in sync with the original project.
- git submodule foreach can be delightful. For example, if all your submodules track a branch, you can do this to do a "git pull" on each submodule:
git submodule foreach git pull
- Removing a submodule is rather awkward. If you can believe it, there is not yet a command to do this. You have to do three things:
- Remove it from the .gitmodules
- Remove it from .git/config
- Remove it from the index: git rm --cached sites/all/modules/xxx
- You'll probably want to use the excellent Git Deploy module, which figures out what version corresponds to the commit for each of your modules. The 2.x version seems to work much better than the previous 1.x versions.
- This is probably obvious, but is worth saying: Everywhere you pull, you need to have network access to and permissions on all of the git repositories mentioned in the remotes of both your main repo and the submodules.
The Good, the Bad, and the Ugly
OK, yes there are tradeoffs in complexity and robustness with the git submodule deployment options
- For a developer, the ability to make and apply patches is marvelous. If you just start working on a patch for a module, everything will work out and you can just use git to do what you need.
- It's nicely integrated with drush dl and drush upc (pm-updatecode)
- You can easily test with various versions of a project and do a git bisect with no trouble at all.
- It's fantastic for rapidly changing environments (like D7 was for a very long time) as everything can be easily updated to any level.
- It results in a completely source controlled environment, completely recreatable from original repositories, with full history, at any time.
- The required git submodule update --init is easy to forget when pulling, and it is annoying that it is required.
- There isn't any explicit support for removing a submodule.
- The fact that multiple repositories must be accessed to update a site adds complexity to the process, and some fragility.
- Using git, the Drupal version number of modules is not in the info file, so git_deploy has to derive it. git describe --all can to tell you what version it's on, but that's a big awkward.
- Pro Git has a great writeup on git submodules
- If you have access to the CommerceGuys intranet, there's a writeup demonstrating the second directory structure (not using the drupal git repo as parent repo)
Basics of deploying with the "Drupal as master repository" repo organization technique:
Additional topics in part 2, including drush integration, different repository organizations, and pros and cons
Do you have comments from your own experience? Feel free to post them here. This is sometimes a controversial topic.