Update Submodules with Git

By  on  

Git submodules seem to confuse people and I can probably count myself in that group of people that are confused.  Their code is kind of part of the codebase, kind of isn't.  Pulling the latest code from the overall project doesn't pull the updated submodule code, so sometimes you get errors and don't know what's going on.  To ensure your submodules are always up to date, run this via the command line:

git submodule update --init --recursive

This command ensure your existing submodules are current as well as adds new submodule code whenever appropriate.  I like to run this at least once a day just to make sure my code is always up to date.  You never know what some of your collaborators have contributed (if you work in a team setting), so running this daily is useful!

Recent Features

  • By
    Create Namespaced Classes with MooTools

    MooTools has always gotten a bit of grief for not inherently using and standardizing namespaced-based JavaScript classes like the Dojo Toolkit does.  Many developers create their classes as globals which is generally frowned up.  I mostly disagree with that stance, but each to their own.  In any event...

  • By
    7 Essential JavaScript Functions

    I remember the early days of JavaScript where you needed a simple function for just about everything because the browser vendors implemented features differently, and not just edge features, basic features, like addEventListener and attachEvent.  Times have changed but there are still a few functions each developer should...

Incredible Demos

  • By
    Styling CSS Print Page Breaks

    It's important to construct your websites in a fashion that lends well to print. I use a page-break CSS class on my websites to tell the browser to insert a page break at strategic points on the page. During the development of my...

  • By
    Create Keyboard Shortcuts with Mousetrap

    Some of the finest parts of web apps are hidden in the little things.  These "small details" can often add up to big, big gains.  One of those small gains can be found in keyboard shortcuts.  Awesome web apps like Gmail and GitHub use loads of...

Discussion

  1. While this is definitely a useful command, it’s worth noting that updating your submodules basically just checks out the revision as defined in the repository. If you’re maintaining a project that uses submodules, this won’t get the latest code for that submodule, so much as it just ensures that the submodule is on the commit as defined.

    For example, I maintain all of my dotfiles in a Git repository, which includes several submodules (Vim plugins, mostly). This command doesn’t actually update the submodules to the latest revision on their branch. If I want to go into each submodule and pull the latest code for each (which can be horribly risky, caveat emptor), I can do something like this:

    git submodule foreach ‘git checkout master && git pull origin master’

    That will go through each of my submodules, ensuring that they are on the latest master branch. That may not be the desired or best behavior, but it is something I learned about with regards to `git submodule update`.

  2. Hi!
    I’m very interested in git’s submodules but I can’t find a tutorial that I can understand properly

    Could you address this? (or at least point me to your reference tutorial)

    Thanks a lot!

  3. Newton

    Why not create a Git hook for this?

    You could use post-checkout & post-merge to automatically fire this on every branch checkout or pull, respectively.

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!