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
    An Interview with Eric Meyer

    Your early CSS books were instrumental in pushing my love for front end technologies. What was it about CSS that you fell in love with and drove you to write about it? At first blush, it was the simplicity of it as compared to the table-and-spacer...

  • By
    5 HTML5 APIs You Didn’t Know Existed

    When you say or read "HTML5", you half expect exotic dancers and unicorns to walk into the room to the tune of "I'm Sexy and I Know It."  Can you blame us though?  We watched the fundamental APIs stagnate for so long that a basic feature...

Incredible Demos

  • By
    Scrolling “Go To Top” Link Using Dojo

    One of the most popular code snippets of posted on my blog has been the scrolling "Go To Top" link snippet. The premise of the snippet is simple: once the user scrolls an element (usually the BODY element) past a given threshold, a "Go...

  • By
    MooTools dwCheckboxes Plugin

    Update / Fix: The checkboxes will no longer toggle when the "mouseup" event doesn't occur on a checkbox. Every morning I wake up to a bunch of emails in my Gmail inbox that I delete without reading. I end up clicking so many damn checkboxes...

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!