Capistrano and nested submodules in Git
UPDATE: it seems like that issue has been covered in the recent versions of git, by passing —recursive parameter to git submodule update command. This parameter is also supported by the recent versions of Capistrano, so this gem is not really necessary anymore. Still, this gem should continue to work if you’re forced to use the older versions of your tools.
So let’s say you have some big codebase in Git repository. Or maybe not even that big, but with a complex dependency added in as a submodule. And this submodule is complex enough that it makes sence for it to reference other project and include them as submodules, too. Sounds too complex? Well, maybe it is, but there’re certain situations when this workflow is plausible, especially if your upstream uses Subversion instead of Git. Symfony comes to mind as an example – huge framework with a number of dependencies (look at version 1.2) that uses svn for development.
You’ve found a good guy at GitHub doing svn clone of upstream’s repository periodically, you’ve pulled his git repo as a submodule, initialized and updates submodules and things look good so far. Feeling lucky, you’re dropping in you Capistrano config, customizing it with your server and repository details, and finally typing your magical “cap deploy”. Still feeling lucky and going to grab that hard-earned cup of coffee? Well, hold on there for a minute and pay some attention. Whooops! What’s this? That bloody thing fails.
The problem here is that Capistrano by default (by that I mean when you have :git_enable_submodules settings in your config file) only issues “git submodule init && git submodule update” at the root of your checked out repository, so if you application depends on any submodules down the tree to be initialized, too – well, “Screeewed!” © GoW2
Being faced with this very problem earlier today I’ve thought it’s a good theme for a plugin, and so one was born – name is “capistrano/deepmodules”. So if you want to easily enable this “deep submodules initialization” feature in your Capistrano, head over to GitHub to take a look at the sources or just install this plugin:
$ sudo gem install capistrano-deepmodules
and that’s pretty much all you need to do. Just require it at your deployment config:
The gem will take care of all the rest automatically. You can delete :git_enable_submodules from your config, the gem pays no attention to it – if you’re requiring it you’re already saying that you want to enable submodules.
And one more detail to pay attention to – at the moment only remote cache strategy is supported by the gem. It means that you MUST add to your config the following line:
set :deploy_via, :remote_cache
It enables the remote cache and it’s really the thing you want to do anyway – deploying large codebases with a lot of submodules and other stuff is really a troublesome experience if you have no server-side cache of it.
Still, if you’re using another strategy and feel like you need this gem to work with it – drop me a note, I’ll see what I can do.
Take care, and never ever again forget your deeply buried submodules!