如何在大型專案中使用Git子模組開發

2021-09-11 15:33:02 字數 3933 閱讀 8418

公司需要開發乙個內部系統,要求每個部門都要接入。老闆欽點,工期又壓得短,於是浩浩湯湯的上百人就調過來了。

再簡單的事情,只要人多起來就會變得複雜,開發的世界也是如此。

乙個幾百人的大專案,使用git協作的時候,想一想我們的痛點:

專案過大,每個人clone等待時間過長

一會沒有拉取**就會發現有上百條更新待拉取

一人提交出錯,上百人待機(筆者真實體驗)

**回溯困難,查詢具體的修改記錄無異***撈針

這時候git子模組就派上用場。

首先需要的當然是乙個合理的架構,由於公司的保密原則這裡就不貼專案了,本文主要描述在協作中子模組的用法。

專案結構

專案主體結構大概是這樣的:

└── src

├── layout // 公共布局目錄

├── public // 公共頁面目錄

├── router // 路由入口

├── components // 通用元件

├── modules // 模組專案開發目錄(子模組)

| ├── tms // 子模組必須

| │ ├── components // 模組通用元件

| │ ├── pages // 模組頁面

| │ ├── router // 模組路由

| │ └── store // 模組vuex資料

| └── ... // 各子模組

└── main.js // 專案入口

複製**

乙個部門乙個子模組,每個子模組必須包含master(生產)、dev(開發)分支(推薦 gitflow 工作流)。

轉殖專案

如所有的webpack專案一樣,src只是業務**,開發配置都放在src外層,所以跑起開發環境首先需要轉殖主專案。

$ git clone 

複製**

新增子模組

當然我們一般不用master分支做開發,正確的姿勢是clone專案之後馬上切換到基於dev的開發分支(原則上業務組不需要關注主專案的開發,主專案由架構組負責,但是為了保證**的最新,並且將子模組新增合併進dev分支中,所以切換到主分支dev)。

$ git checkout -b dev origin/dev

複製**

這時候如果你的專案中已經有子模組了,你會發現modules資料夾下已經有了乙個個子模組,但是顯然現在這些模組都是空目錄(預期的結果,我們不需要關注其他模組)。同時專案根目錄下有乙個.gitmodules檔案,內容如下:

[submodule "modules/suba"]

path = modules/suba

url =

複製**

這裡就是你的子模組關聯檔案,每新增乙個子模組就會新增一條記錄,如果是第一次新增git子模組會自動生成。

開發環境有了,現在需要關聯你的子模組:

$ git submodule add  modules/subb

複製**

首次新增的子模組會拉取整個專案,開啟muodules/subb資料夾,整個子模組專案都完好地列在那裡,同時.gitmodules裡新增了一條子模組記錄modules/subb

編輯子模組

同樣的,我們也不應該在子模組的master分支上做任何編輯,這時候我們需要將子模組切換到基於dev的開發分支。

進入子模組目錄下:

$ cd modules/subb/

$ git checkout -b feature/some-change origin/dev

複製**

當你在子模組做完一些修改一些修改之後,你想要把這這些修改推送到遠端。

$ git commit -am 'test commit submodule'

$ git checkout dev

$ git merge feature/some-change

$ git push origin dev

$ git branch -d feature/some-change

複製**

這時候你的子模組的修改就已經提交到遠端了,但是如果你進如到主專案的根目錄檢視差異,你會發現主專案中多了一些修改:

$ cd ../../

$ git diff

> diff --git a/subb b/subb

index 433859c..b78179a 160000

--- a/subb

+++ b/subb

@@ -1 +1 @@

-subproject commit 433859c90e539d2a1b9fda27b32bef0d0acae9e6

+subproject commit b78179adab252a524ff2a41d6407a7daa6dad34f

複製**

這是因為你修改了子模組subb並提交了,但是主專案的指標依舊指向那個老的commit id,如果你不提交這個修改的話,別人拉取主專案並且使用git submodule update更新子模組還是會拉取到你修改前的**。

所以這時候你需要把主專案也提交一遍:

$ git commit -am "test commit submodule"

$ git push origin dev

複製**

這樣,你的修改就已經全部提交了。

新成員加入

當有新成員你加入你的子模組並且需要拉取**的時候:

$ git clone 

$ git checkout -b dev origin/dev

$ git submodule init

$ git submodule update subb

複製**

git submodule update [submodule name]是指定拉取指定子模組的用法,如果你需要更新所有的子模組只需要使用git submodule update就可以了,一般我們在協作中只關注自己的模組。

那麼接下來新成員也可以延續我們上面的開發流程了。

刪除子模組

$ git rm -r modules/subb

複製**

[submodule "modules/subb"]

path = modules/subb

url =

branch = dev

複製**

[submodule "modules/subb"]

url =

active = true

複製**

$ rm -rf .git/modules/subb

複製**

接下來提交修改:

$ git commit -am "delete subb"

$ git push origin dev

複製**

發布專案

當整個開發流程都結束了,終於到了發布的時刻,當然需要在主專案更新你的所有子模組:

$ git checkout master

$ git pull origin master

$ git submodule update

$ yarn build

複製**

-- the end

如何在Flutter專案中使用GraphQL

麼是graphql 這篇文章主要是看一下如何在flutter專案中使用graphql,如果不清楚graphql是什麼,建議先看下官網對其介紹 從圖中也能看出,分3部分 可以看出,在這個graphql server中,我們可以查詢 continents continent countries coun...

如何在CPP專案中使用CUDA

很多時候我們需要對乙個cpp專案中某一部分進行gpu加速,如下步驟能夠實現這一目的。直接新建或者開啟已有的cpp專案 右鍵專案,新建或者新增已有的.cu cu 件 注意 cpp檔案不能直接呼叫kernel函式 新增了cuda的標頭檔案也不行 於是我們可以以函式呼叫的方式,從.cpp檔案呼叫乙個.cu...

c語言 如何在專案中使用陣列

用乙個最簡單理解的專案來教大家怎麼用陣列吧,就寫乙個錄入並檢視十名同學的成績好了。首先建立乙個陣列,然後迴圈十次每次錄入一名同學成績,十次迴圈結束同學的成績也就全部錄入完畢 include int main printf 檢視十名學生成績 n for int i 0 i 10 i return0 注...