Tags

  • AWS (7)
  • Apigee (3)
  • ArchLinux (5)
  • Array (6)
  • Backtracking (6)
  • BinarySearch (6)
  • C++ (19)
  • CI&CD (3)
  • Calculus (2)
  • DesignPattern (43)
  • DisasterRecovery (1)
  • Docker (8)
  • DynamicProgramming (20)
  • FileSystem (11)
  • Frontend (2)
  • FunctionalProgramming (1)
  • GCP (1)
  • Gentoo (6)
  • Git (16)
  • Golang (1)
  • Graph (10)
  • GraphQL (1)
  • Hardware (1)
  • Hash (1)
  • Kafka (1)
  • LinkedList (13)
  • Linux (27)
  • Lodash (2)
  • MacOS (3)
  • Makefile (1)
  • Map (5)
  • MathHistory (1)
  • MySQL (21)
  • Neovim (11)
  • Network (67)
  • Nginx (6)
  • Node.js (33)
  • OpenGL (6)
  • PriorityQueue (1)
  • ProgrammingLanguage (9)
  • Python (10)
  • RealAnalysis (20)
  • Recursion (3)
  • Redis (1)
  • RegularExpression (1)
  • Ruby (19)
  • SQLite (1)
  • Sentry (3)
  • Set (4)
  • Shell (4)
  • SoftwareEngineering (12)
  • Sorting (2)
  • Stack (4)
  • String (2)
  • SystemDesign (13)
  • Terraform (2)
  • Tree (24)
  • Trie (2)
  • TwoPointers (16)
  • TypeScript (3)
  • Ubuntu (4)
  • Home

    Git Submodule

    Published Mar 15, 2025 [  Git  ]

    A Git submodule is a way to include one Git repository inside another. This is useful when you want to manage dependencies or separate concerns in a modular fashion.

    🔹 Why Use Submodules?

    • To include external libraries or dependencies without merging their history into your main project.
    • To keep separate repositories but still work with them as part of a larger project.
    • To track a specific commit of an external project instead of the latest changes.

    🔹 Basic Commands

    1️⃣ Adding a Submodule

    git submodule add <repository-url> <path>
    

    This adds a submodule and records its exact commit in your project.

    2️⃣ Cloning a Repository with Submodules

    By default, git clone does not pull submodules. To clone a repo with submodules, use:

    git clone --recursive <repository-url>
    

    If you forgot --recursive, initialize submodules manually:

    git submodule update --init --recursive
    

    3️⃣ Updating a Submodule

    To update the submodule to the latest commit from its repository:

    cd <submodule-path>
    git pull origin main  # Update the submodule to the latest commit
    cd ..
    git add <submodule-path>
    git commit -m "Updated submodule"
    

    4️⃣ Removing a Submodule

    git submodule deinit -f <path>
    git rm -f <path>
    rm -rf .git/modules/<path>
    

    This removes all traces of the submodule from your repo.


    Let me know if you need more details! 🚀