柚子快報(bào)邀請(qǐng)碼778899分享：git子模塊
柚子快報(bào)邀請(qǐng)碼778899分享：git子模塊
1 子模塊管理的關(guān)鍵文件和配置
在 Git 中使用子模塊時(shí)，Git 會(huì)利用幾個(gè)特殊的文件和配置來(lái)管理子模塊。以下是涉及子模塊管理的關(guān)鍵文件和配置：
1.1 .gitmodules
這是一個(gè)文本文件，位于 Git 倉(cāng)庫(kù)的根目錄下。它記錄了子模塊的信息，包括每個(gè)子模塊的路徑、URL 和分支。這個(gè)文件應(yīng)該被添加到版本控制中，以便其他克隆了主倉(cāng)庫(kù)的人也能獲取和初始化子模塊。
示例 .gitmodules 文件內(nèi)容：
[submodule "AIGC/opencompass"]
path = AIGC/opencompass
url = https://github.com/open-compass/opencompass.git
branch = master
1.2 .git/config
這是 Git 倉(cāng)庫(kù)的本地配置文件。它也包含有關(guān)子模塊的信息，通常在運(yùn)行 git submodule init 時(shí)，子模塊的信息會(huì)從 .gitmodules 被復(fù)制到 .git/config 中。.git/config 文件存儲(chǔ)的子模塊信息是本地特有的，不會(huì)被推送到遠(yuǎn)程倉(cāng)庫(kù)。
1.3 .git/modules
這是存儲(chǔ)子模塊 Git 倉(cāng)庫(kù)數(shù)據(jù)的目錄。當(dāng)您初始化子模塊時(shí)，Git 會(huì)在這個(gè)目錄下創(chuàng)建一個(gè)子目錄來(lái)存儲(chǔ)每個(gè)子模塊的 Git 數(shù)據(jù)（例如對(duì)象、引用等）。這個(gè)結(jié)構(gòu)使得主倉(cāng)庫(kù)能夠維護(hù)干凈的目錄結(jié)構(gòu)，同時(shí)保持子模塊作為獨(dú)立倉(cāng)庫(kù)的數(shù)據(jù)。
1.4 子模塊目錄
子模塊的實(shí)際內(nèi)容被克隆到主倉(cāng)庫(kù)的子目錄中，該目錄由 .gitmodules 中的 path 指定。子模塊目錄內(nèi)部會(huì)有一個(gè) .git 文件，該文件指向?qū)嶋H的 Git 數(shù)據(jù)存儲(chǔ)位置，通常是 ../../.git/modules/path/to/submodule。
1.5 處理子模塊的 Git 命令
雖然這些不是文件，但了解相關(guān)的 Git 命令對(duì)于管理子模塊同樣重要：
git submodule add
通過(guò)正確使用這些文件和命令，可以有效地管理包含子模塊的 Git 倉(cāng)庫(kù)。這對(duì)于包含第三方依賴或庫(kù)的項(xiàng)目尤其重要。
2 子模塊和主倉(cāng)庫(kù)的提交
需要分開(kāi)處理當(dāng)您在一個(gè)包含子模塊的 Git 倉(cāng)庫(kù)中修改了子模塊的內(nèi)容，不能直接使用 git commit -a -m 'XXX 來(lái)提交主倉(cāng)庫(kù)和子模塊的變更。這是因?yàn)樽幽K在 Git 中被視為獨(dú)立的倉(cāng)庫(kù)，它們有自己的獨(dú)立版本歷史。
2.1 提交子模塊的變更
首先，您需要進(jìn)入子模塊的目錄，并對(duì)子模塊內(nèi)的變更進(jìn)行提交：
cd AIGC/opencompass # 進(jìn)入子模塊目錄
git add . # 添加所有變更到暫存區(qū)
git commit -m "Describe changes made in the submodule"
這一步確保了子模塊的變更被記錄在子模塊的版本歷史中。如果您嘗試在主倉(cāng)庫(kù)中使用 git commit -a，它只會(huì)記錄子模塊的新提交引用，而不會(huì)提交子模塊內(nèi)部的實(shí)際文件變更。
2.2 提交主倉(cāng)庫(kù)的變更
返回到主倉(cāng)庫(kù)目錄，提交子模塊的新?tīng)顟B(tài)（這實(shí)際上是子模塊的新提交哈希）到主倉(cāng)庫(kù)：
cd ../.. # 返回到主倉(cāng)庫(kù)根目錄
git add AIGC/opencompass # 將子模塊的新?tīng)顟B(tài)添加到暫存區(qū)
git commit -m "Update submodule reference to the latest commit"
這一步是必要的，因?yàn)殡m然子模塊的內(nèi)容已經(jīng)在子模塊的倉(cāng)庫(kù)中被提交，但是主倉(cāng)庫(kù)需要更新其記錄的子模塊的引用（即子模塊的提交哈希），以反映子模塊的最新?tīng)顟B(tài)。
3.3 推送變更
完成以上步驟后，推送主倉(cāng)庫(kù)和子模塊的變更到遠(yuǎn)程倉(cāng)庫(kù)：
git push origin master # 推送主倉(cāng)庫(kù)變更
cd AIGC/opencompass # 再次進(jìn)入子模塊
git push origin master # 推送子模塊變更
3 清理并重新添加子模塊（如果需要）
3.1 清理子模塊
git submodule deinit -f AIGC/opencompass
rm -rf .git/modules/AIGC/opencompass
git rm -f AIGC/opencompass
git add .
git commit -m "Remove submodule"
3.2 重新添加子模塊
git submodule add https://github.com/open-compass/opencompass.git AIGC/opencompass
git submodule update --init --recursive
4 管理遠(yuǎn)程倉(cāng)庫(kù)拉取更新并推送到另一個(gè)遠(yuǎn)程倉(cāng)庫(kù)的子模塊
要按照以下步驟操作：
4.1確保子模塊正確初始化和更新
首先，確保子模塊已經(jīng)正確初始化并鏈接到正確的遠(yuǎn)程倉(cāng)庫(kù)。
cd AIGC/opencompass
git submodule update --init
4.2 將子模塊的遠(yuǎn)程倉(cāng)庫(kù)設(shè)置為 GitHub
進(jìn)入子模塊目錄，并將其遠(yuǎn)程倉(cāng)庫(kù)設(shè)置為 GitHub 上的 URL。
cd AIGC/opencompass
git remote add upstream https://github.com/open-compass/opencompass.git
這里使用 upstream 作為遠(yuǎn)程倉(cāng)庫(kù)的名稱，表示原始源頭倉(cāng)庫(kù)。如果 upstream 已經(jīng)存在，您可能需要先用 git remote remove upstream 刪除舊的遠(yuǎn)程配置。
4.3 從 GitHub 拉取最新更新
從 GitHub 的倉(cāng)庫(kù)拉取最新的更新到本地。
git fetch upstream
git checkout master # 或者您需要同步的分支
git merge upstream/master
處理可能出現(xiàn)的合并沖突，并提交這些更改。
4.4 推送更新到您的公司倉(cāng)庫(kù)
將更新后的內(nèi)容推送到公司的遠(yuǎn)程倉(cāng)庫(kù)。首先確認(rèn)您有權(quán)限推送到該倉(cāng)庫(kù)，并且已經(jīng)設(shè)置了正確的遠(yuǎn)程倉(cāng)庫(kù)地址。
git remote add origin ssh://100@10.95.243.146:29418/SystemTestDep/TestTestToolSoftware/jingzhun/AIGC/opencompass
git push origin master
這里使用 origin 作為遠(yuǎn)程倉(cāng)庫(kù)的名稱，如果已經(jīng)設(shè)置了不同的倉(cāng)庫(kù)地址，可能需要更新或使用不同的遠(yuǎn)程名稱。
4.5 確保主項(xiàng)目中的子模塊引用更新
回到主項(xiàng)目目錄，更新子模塊的引用并提交這些更改。
cd ../..
git add AIGC/opencompass
git commit -m "Update submodule reference to the latest commit"
git push
這確保了主項(xiàng)目引用了子模塊的最新提交。
4.6 注意事項(xiàng)
合并沖突：在合并 GitHub 上的更改時(shí)，您可能會(huì)遇到?jīng)_突。確保仔細(xì)解決所有沖突，并在本地測(cè)試所有更改以確保一切功能正常。 權(quán)限：確保您擁有所有遠(yuǎn)程倉(cāng)庫(kù)的推送權(quán)限。如果不確定，與您的系統(tǒng)管理員確認(rèn)。 驗(yàn)證遠(yuǎn)程 URL：使用 git remote -v 查看遠(yuǎn)程倉(cāng)庫(kù)的 URL 是否正確設(shè)置。
通過(guò)這些步驟，您可以有效地管理涉及多個(gè)遠(yuǎn)程倉(cāng)庫(kù)的子模塊更新和推送操作。
5 錯(cuò)誤信息 fatal: 遠(yuǎn)程 origin 已經(jīng)存在
表示 Git 倉(cāng)庫(kù)中已經(jīng)有一個(gè)名為 origin 的遠(yuǎn)程倉(cāng)庫(kù)配置。如果您想更改 origin 的 URL 或者添加一個(gè)新的遠(yuǎn)程倉(cāng)庫(kù)，您可以采取以下幾個(gè)不同的步驟：
5.1 查看當(dāng)前的遠(yuǎn)程倉(cāng)庫(kù)配置
首先，檢查現(xiàn)有的 origin 遠(yuǎn)程倉(cāng)庫(kù)配置，看看它指向哪里：
git remote -v
這會(huì)顯示所有遠(yuǎn)程倉(cāng)庫(kù)的名稱及其對(duì)應(yīng)的 URL。
5.2 更改現(xiàn)有的遠(yuǎn)程倉(cāng)庫(kù) URL
如果您想要更改已存在的 origin 遠(yuǎn)程倉(cāng)庫(kù)的 URL，可以使用以下命令：
git remote set-url origin ssh://100@10.95.243.146:29418/SystemTestDep/TestTestToolSoftware/jingzhun/AIGC/opencompass
這個(gè)命令會(huì)更新 origin 的 URL 到新的地址。
5.3 移除并重新添加遠(yuǎn)程倉(cāng)庫(kù)
如果您想完全重新配置 origin，可以先刪除現(xiàn)有的遠(yuǎn)程倉(cāng)庫(kù)，然后再添加新的：
git remote remove origin
git remote add origin ssh://100@10.95.243.146:29418/SystemTestDep/TestTestToolSoftware/jingzhun/AIGC/opencompass
這將刪除舊的 origin 并用新的 URL 添加它。
5.4 添加一個(gè)不同名稱的遠(yuǎn)程倉(cāng)庫(kù)
如果您想保留 origin 并添加另一個(gè)遠(yuǎn)程倉(cāng)庫(kù)，可以選擇一個(gè)不同的名稱：
git remote add another-origin ssh://100@10.95.243.146:29418/SystemTestDep/TestTestToolSoftware/jingzhun/AIGC/opencompass
這樣，您可以有多個(gè)遠(yuǎn)程倉(cāng)庫(kù)配置，可以自由地推送和拉取到不同的遠(yuǎn)程倉(cāng)庫(kù)。
6 在主工程中包含一個(gè)第三方庫(kù)作為子目錄同時(shí)保留所做的修改并定期更新
6.1 使用 Git 子模塊（Submodule）
Git 子模塊允許您將一個(gè)Git倉(cāng)庫(kù)作為另一個(gè)Git倉(cāng)庫(kù)的子目錄，它可以在主倉(cāng)庫(kù)中保持自己的獨(dú)立版本歷史。
優(yōu)點(diǎn)：
子模塊和主倉(cāng)庫(kù)獨(dú)立管理，易于跟蹤第三方庫(kù)的更新?？梢赃x擇性地更新子模塊，同時(shí)保持對(duì)子模塊的更改。
操作步驟：
將第三方庫(kù)作為子模塊添加到您的主工程中：git submodule add
當(dāng)?shù)谌綆?kù)有更新時(shí)，您可以進(jìn)入子模塊目錄，拉取最新的更改：cd
git pull origin master # 假設(shè)您關(guān)注的是 master 分支
解決可能出現(xiàn)的合并沖突，確保您的修改得以保留。提交更新到主倉(cāng)庫(kù)，包括子模塊的新提交引用：cd
git add .
git commit -m "Update submodule to latest version"
6.2 使用 Git 子樹(shù)（Subtree）
Git 子樹(shù)允許您將第三方庫(kù)合并到您的主倉(cāng)庫(kù)中，作為項(xiàng)目的一部分處理，同時(shí)仍然能夠從上游庫(kù)拉取更新。
優(yōu)點(diǎn)：
子樹(shù)是主倉(cāng)庫(kù)的一部分，不需要初始化或更新子模塊。方便同時(shí)提交對(duì)主倉(cāng)庫(kù)和子樹(shù)的更改。
操作步驟：
將第三方庫(kù)作為子樹(shù)添加到您的主工程中：git subtree add --prefix
拉取并合并第三方庫(kù)的更新：git subtree pull --prefix
解決合并中出現(xiàn)的沖突，保留您的更改。提交更新到您的主倉(cāng)庫(kù)。
6.3 簡(jiǎn)單嵌套的方式
將一個(gè)第三方庫(kù)的Git倉(cāng)庫(kù)簡(jiǎn)單地克隆到您的主倉(cāng)庫(kù)的子目錄中，但不使用Git的子模塊或子樹(shù)功能，確實(shí)是一種可行的方法，特別是如果您想保持操作的簡(jiǎn)便性。簡(jiǎn)單嵌套的方式在操作上可能更直接，特別是對(duì)于小型項(xiàng)目或者不需要頻繁同步第三方庫(kù)更新的情況。然而，如果第三方庫(kù)更新頻繁，或者需要精確追蹤第三方庫(kù)的變更，使用Git子模塊或子樹(shù)可能是更好的選擇，因?yàn)檫@些方法提供了更好的工具來(lái)管理和集成外部庫(kù)的更新。
優(yōu)點(diǎn)
簡(jiǎn)單易懂：不需要配置子模塊或子樹(shù)，對(duì)Git新手來(lái)說(shuō)更加直觀。獨(dú)立操作：第三方庫(kù)完全獨(dú)立于主倉(cāng)庫(kù)，可以單獨(dú)進(jìn)行版本控制和管理。
缺點(diǎn)
更新復(fù)雜：當(dāng)?shù)谌綆?kù)需要更新時(shí)，需要手動(dòng)處理可能出現(xiàn)的合并沖突，并確保自己的修改不會(huì)被覆蓋。版本跟蹤不便：主倉(cāng)庫(kù)無(wú)法直接追蹤子目錄庫(kù)的版本變化，不易管理子目錄庫(kù)的具體版本。忽略處理：為了防止主倉(cāng)庫(kù)對(duì)子目錄進(jìn)行版本控制，可能需要在 .gitignore 中添加規(guī)則來(lái)忽略子目錄。
如果選擇簡(jiǎn)單嵌套的方式，以下是一個(gè)基本的操作流程：
克隆第三方庫(kù)到子目錄 cd path/to/your/main/project
git clone https://github.com/third-party/library path/to/subdirectory
在主項(xiàng)目的 .gitignore 文件中忽略該子目錄 (可選) # .gitignore
path/to/subdirectory/
定期更新第三方庫(kù)
進(jìn)入子目錄，拉取最新的更新：cd path/to/subdirectory
git pull origin master
解決可能出現(xiàn)的合并沖突，并確保您的修改被適當(dāng)?shù)睾喜ⅰ? 將修改提交到第三方庫(kù)的本地或遠(yuǎn)程分支（如果有權(quán)限） git add .
git commit -m "Your custom changes"
git push origin your-branch
柚子快報(bào)邀請(qǐng)碼778899分享：git子模塊
推薦文章
本文內(nèi)容根據(jù)網(wǎng)絡(luò)資料整理，出于傳遞更多信息之目的，不代表金鑰匙跨境贊同其觀點(diǎn)和立場(chǎng)。
轉(zhuǎn)載請(qǐng)注明，如有侵權(quán)，聯(lián)系刪除。
AsosMarketplace時(shí)尚出海購(gòu)
