[TOC] ## 概述 - submodule 是一個很好的多項目使用共同類庫的工具 - 它允許類庫項目做為repository,子項目做為一個單獨的git項目存在父項目中，子項目可以有自己的獨立的commit，push，pull - 父項目以Submodule的形式包含子項目 - 子模塊可以有多個 - 某個子模塊表現為一個目錄, 如 [actionview](https://github.com/lxerxa/actionview) ## 語法 ``` git submodule [--quiet] add [<options>] [--] <repository> [<path>] git submodule [--quiet] status [--cached] [--recursive] [--] [<path>…?] git submodule [--quiet] init [--] [<path>…?] git submodule [--quiet] deinit [-f|--force] (--all|[--] <path>…?) git submodule [--quiet] update [<options>] [--] [<path>…?] git submodule [--quiet] summary [<options>] [--] [<path>…?] git submodule [--quiet] foreach [--recursive] <command> git submodule [--quiet] sync [--recursive] [--] [<path>…?] git submodule [--quiet] absorbgitdirs [--] [<path>…?] ``` ## 場景 ### 創建子模塊 ``` git submodule add git@github.com:zjZSTU/hexo-theme-next.git blogs/themes/next ``` 除了添加子倉庫之外,還生成了一個配置文件`.gitmodules` ``` > cat .gitmodules [submodule "blogs/themes/next"] path = blogs/themes/next url = git@github.com:zjZSTU/hexo-theme-next.git ``` ### 管理子模塊 主倉庫只能提示子模塊中的文件修改,必須子模塊自己進行添加和上傳 ### 子模塊的更新 ``` // 進入子模塊 git pull // 完成后返回到項目目錄，可以看到子模塊有待提交的更新 git add ``` ### clone 帶子模塊的項目 1. 直接拉取帶子模塊的 倉庫,加 `--recursive` ``` git clone https://github.com/yyy/xxx.git --recursive ``` 2. 在已clone 的模塊中拉取子模塊 方式一: ``` # 初始化本地配置文件 $ git submodule init # 拉取遠程倉庫 $ git submodule update ``` 方式二: ``` git submodule update --init ``` 方式三:如果有嵌套的子模塊 ``` git submodule update --init --recursive ``` ### 修改某子模塊URL 1. 修改`.gitmodules`文件中對應模塊的”url“屬性; 2. 使用`git submodule sync`命令，將新的URL更新到文件`.git/config`； ### 刪除Submodule git 并不支持直接刪除Submodule需要手動刪除對應的文件: ``` // 逆初始化模塊,執行后可發現模塊目錄被清空 > git submodule deinit DbConnector // 刪除.gitmodules中記錄的模塊信息 > git rm --cached DbConnector // 提交更改到代碼庫，可觀察到'.gitmodules'內容發生變更 > git commit -am "Remove a submodule." ``` ### 主模塊提交時,忽略子模塊 ``` > cat .gitmodule [submodule "blogs/themes/next"] path = blogs/themes/next url = https://github.com/zjZSTU/hexo-theme-next.git ignore = all ``` 設置 ignore 設置為 all