CI/CD 模組導入標準作業程序 (SOP)¶

本文件說明如何將共用模組 java-modules 導入專案，以標準化建置流程。

1. 前置確認 (Prerequisites)¶

• 確認您擁有目標專案的 Maintainer 權限。
• 確認共用模組權限設定：GitLab CI/CD Settings

2. 導入步驟 (Installation)¶

Step 1: 加入子模組 (Submodule)¶

在專案根目錄執行以下指令，將共用模板加入為子模組：

# 加入 submodule (資料夾命名為 cicd-scripts)
git submodule add ../cicd-templates/java-modules.git cicd-scripts

Step 2: 調整專案結構¶

建立部署設定資料夾，並將環境設定檔移入其中：

mkdir -p deploy-configs
mv ENV.config deploy-configs/

Step 3: 設定 .gitlab-ci.yml¶

將標準 CI 範本複製到專案根目錄，並修改 variables 區塊：

• IMAGE_NAME_X：依照 deploy-configs/ENV.config 內的順序填入（X 為序號 1, 2...）。
• MEMORY_LIMIT_X：容器記憶體限制。
  • 設定依據：查看原專案 set_helm 目錄下的 values.yaml。
  • 預設值：若未指定，預設為 1G。
  • 自訂值：若有特定需求，請依照 config 順序填入對應數值（如 2G, 512M）。

3. 維護與更新 (Maintenance)¶

** 重要觀念**：
Git Submodule 是鎖定在特定的 Git SHA (Commit ID)。
當共用模組有更新時，本專案不會自動更新，必須手動執行以下指令來拉取新版本。

方法 A：快速更新 (推薦)¶

直接將子模組更新到遠端最新版本：

# 1. 更新 submodule 指標
git submodule update --remote

# 2. 提交變更 (重要：必須 commit 才會生效)
git add cicd-scripts
git commit -m "chore: update cicd-scripts to latest version"
git push

方法 B：手動檢查更新¶

若需檢查狀態或切換特定版本：

cd cicd-scripts

# 檢查目前狀態
git status

# 拉取更新 (如同一般 git 操作)
git checkout main
git pull

# 完成後，回到根目錄提交
cd ..
git add cicd-scripts
git commit -m "chore: update cicd-scripts manually"