在習慣 go mod 後重新學習 git submodule

raiven.kao@gmail.com (Raiven Kao) — Fri, 24 Jan 2025 00:00:00 +0000

前言

使用 Golang 作為主要開發已經有五年的時間。最近因工作需要接觸到 Python 專案，並且該專案使用 git submodule 的方式來引用共同函式庫 common-lib-python。對於長久使用 Golang 的 go mod 的我來說，submodule 是一個相對陌生的概念。藉這個機會撰寫一篇文章，整理並紀錄一下 git submodule 的用法，也作為未來的參考。

這篇文章會假設已經對 git 的基本操作有一定程度的了解，並著重在 submodule 的概念、使用情境以及與 Golang 的 go mod 的差異比較。文章內容會以下列流程來呈現：

建立一個新的 Python 專案 my-python-repo
建立一個 Python 模組 my-python-module 作為 submodule
在 my-python-repo 中使用 my-python-module 作為 submodule
模擬需求變更，同時修改 my-python-repo 與 my-python-module，並分別發送 PR
與 Golang 的 go mod 進行比較

建立 Python 專案與模組

先建立兩個新的 git repo，分別是 my-python-repo 與 my-python-module。

# 建立 my-python-repo
mkdir my-python-repo
cd my-python-repo
git init
touch main.py
git add .
git commit -m "Initial commit"

# 建立 my-python-module
cd ..
mkdir my-python-module
cd my-python-module
git init
touch my_module.py
git add .
git commit -m "Initial commit"

# 將兩個專案 push 到 Github/Gitlab 上

my-python-repo 與 my-python-module 都已經是一個獨立的 git repo。

Git on omegaatt

在習慣 go mod 後重新學習 git submodule

前言

建立 Python 專案與模組