使用 GTWS 管理複雜的 Git 工作空間

GTWS 是一系列指令碼，它使我們在開發環境中管理不同的專案和專案的各個版本變得很容易。

Great Teeming Workspaces（GTWS）是一個 Git 的複雜工作空間管理工具包，它使我們在開發環境中管理不同的專案和專案的各個版本變得很容易。

有點像 Python 的 venv，但不是為 Python 語言準備的。GTWS 用來管理多個專案的多個版本的工作空間。你可以很容易地建立、更新、進入和離開工作空間，每個專案或版本的組合（最多）有一個原生的 origin，用來與 upstream 同步 — 其餘的所有工作空間都從原生的 origin 更新。

部署

${GTWS_ORIGIN}/<project>/<repo>[/<version>]${GTWS_BASE_SRCDIR}/<project>/<version>/<workspacename>/{<repo>[,<repo>...]}

原始碼目錄的每一級（包括全域性的家目錄）可以包含一個 .gtwsrc 檔案，這個檔案中維護與當前級相關的設定和 bash 程式碼。每一級的設定會覆蓋上一級。

安裝

用下面的命令檢出 GTWS：

git clone https://github.com/dang/gtws.git

設定你的 ${HOME}/.gtwsrc。它應該包含 GTWS_ORIGIN，也可以再包含 GTWS_SETPROMPT。

把倉庫目錄加到環境變數中：

export PATH="${PATH}:/path/to/gtws

設定

通過級聯 .gtwsrc 檔案來進行設定。它從根目錄向下遍歷，會執行在每級目錄中找到的 .gtwsrc 檔案。下級目錄的檔案會覆蓋上一級。

在你最上層的檔案 ~/.gtws/.gtwsrc 中進行如下設定：

• GTWS_BASE_SRCDIR：所有專案原始檔目錄樹的基目錄。預設為 $HOME/src。
• GTWS_ORIGIN： 指定 origin git 目錄樹的路徑。預設為 $HOME/origin。
• GTWS_SETPROMPT： 可選設定。如果設定了這個引數，shell 提示符會有工作空間的名字。
• GTWS_DEFAULT_PROJECT： 不指定專案或專案未知時預設的專案名。如果不指定，使用命令列時必須指明專案。
• GTWS_DEFAULT_PROJECT_VERSION： 檢出的預設版本。預設為 master。

在每個專案的根目錄進行以下設定：

• GTWS_PROJECT： 專案的名字（和基目錄）。
• gtws_project_clone： 這個函數用於克隆一個專案的指定版本。如果未定義，它會假定專案的 origin 對每一個版本都有一個單獨的目錄，這樣會導致克隆一堆 Git 倉庫。
• gtws_project_setup： 在克隆完所有的倉庫後，可以選擇是否呼叫這個函數，呼叫後可以對專案進行必要的設定，如在 IDE 中設定工作空間。

在專案版本級進行以下設定：

• GTWS_PROJECT_VERSION： 專案的版本。用於正確地從 origin 拉取程式碼。類似 Git 中的分支名字。

下面這些引數可以在目錄樹的任意地方進行設定，如果能生效，它們可以被重寫多次：

• GTWS_PATH_EXTRA： 這些是工作空間中加到路徑後的額外的路徑元素。
• GTWS_FILES_EXTRA： 這些是不在版本控制內，但應該在工作空間中被檢出的額外的檔案。這些檔案包括 .git/info/exclude，每個檔案都與倉庫的基目錄相關聯。

origin 目錄

GTWS_ORIGIN （大部分指令碼中）指向拉取和推播的原始 Git 檢出目錄。

${GTWS_ORIGIN} 部署：

• /<project>
  • 這是一個專案的倉庫的基目錄。
  • 如果指定了 gtws_project_clone，你可以設定任意的部署路徑。
  • 如果沒有指定 gtws_project_clone，這個路徑下必須有個名為 git 的子目錄，且 git 目錄下有一系列用來克隆的裸 Git 倉庫。

工作流範例

假設你有一個專案名為 Foo，它的 upstream 為 github.com/foo/foo.git。這個倉庫有個名為 bar 的子模組，它的 upstream 是 github.com/bar/bar.git。Foo 專案在 master 分支開發，使用穩定版本的分支。

為了能在 Foo 中使用 GTWS，你首先要設定目錄結構。本例中假設你使用預設的目錄結構。

• 設定你最上層的 .gtwsrc：
  • cp ${GTWS_LOC}/examples/gtwsrc.top ~/.gtwsrc
  • 根據需要修改 ~/.gtwsrc。
• 建立頂級目錄：
  • mkdir -p ~/origin ~/src

• 建立並設定專案目錄：

  • mkdir -p ~/src/foo

    cp ${GTWS_LOC}/examples/gtwsrc.project ~/src/foo/.gtwsrc

  • 根據需要修改 ~/src/foo/.gtwsrc。

• 建立並設定 master 版本目錄：

  • mkdir -p ~/src/foo/master

    cp ${GTWS_LOC}/examples/gtwsrc.version ~/src/foo/master/.gtwsrc

  • 根據需要修改 ~/src/foo/master/.gtwsrc。

• 進入版本目錄並建立一個臨時工作空間來設定映象：

  • mkdir -p ~/src/foo/master/tmp

    cd ~/src/foo/master/tmp

    git clone --recurse-submodules git://github.com/foo/foo.git

    cd foo

    gtws-mirror -o ~/origin -p foo（譯註：這個地方原文有誤，不加 -s 引數會報錯）

  • 上面命令會建立 ~/origin/foo/git/foo.git 和 ~/origin/foo/submodule/bar.git。

  • 以後的克隆操作會從這些 origin 而不是 upstream 克隆。

  • 現在可以刪除工作空間了。

到現在為止，Foo 的 master 分支的工作可以結束了。假設你現在想修復一個 bug，名為 bug1234。你可以脫離你當前的工作空間為修復這個 bug 單獨建立一個工作空間，之後在新建立的工作空間中開發。

• 進入版本目錄，建立一個新的工作空間：

  • cd ~/src/foo/master

    mkws bug1234

  • 上面的命令建立了 bug1234/，在這個目錄下檢出了 Foo（和它的子模組 bar），並建立了 build/foo 來構建它。

• 有兩種方式進入工作空間：

  • cd ~/src/foo/master/bug1234

    startws

    或者

    cd ~/src/foo/master/

    startws bug1234

  • 上面的命令在 bug1234 工作空間中開啟了一個子 shell。這個 shell 有 GTWS 的環境和你在各級 .gtwsrc 檔案中設定的環境。它也把你工作空間的基目錄加入到了 CD，因此你可以從 base 路徑 cd 到相關的目錄中。

  • 現在你可以修復 bug1234 了，構建、測試、提交你的修改。當你可以把程式碼推播到 upstream 時，執行下面的命令：

    cd foo

    wspush 

  • wspush 會把程式碼推播到與你工作空間相關的分支 — 先推播到原生的 origin，再推播到 upstream。

  • 當 upstream 有修改時，你可以用下面的命令同步到本地：

    git sync

  • 上面的命令呼叫了 GTWS 的 git-sync 指令碼，會從本地 origin 更新程式碼。使用下面的命令來更新原生的 origin：

    git sync -o 

  • 上面的命令會更新你原生的 origin 和子模組的映象，然後用那些命令來更新你的檢出倉庫的程式碼。git-sync 也有一些其他的很好的工鞥。

  • 當要結束工作空間中的工作時，直接退出 shell：

    exit

  • 你可以在任何時間重複進入工作空間，也可以在同一時間在相同的工作空間中開多個 shell。

• 當你不需要某個工作空間時，你可以使用 rmws 來刪除它，或者直接刪除它的目錄樹。

• 還有一個指令碼 tmws 使用 tmux 進入工作空間，能建立一系列的視窗/窗格，這完美契合我的工作流。你可以根據你自己的需求來修改它。