透過 GitLab CI/CD 自動更新版本號並發布

GitLab CI/CD 是基於 GitLab 的持續整合與持續交付服務,它可以幫助開發者在每次提交程式碼後自動執行一系列任務,例如編譯、測試、打包和部署。本文將介紹如何使用 GitLab CI/CD 自動遞增版本號並 push 到儲存庫,擺脫手動更新版本號的困擾。

先決條件

  • 擁有一個 GitLab 帳號,並建立或匯入一個專案
  • 在專案根目錄下建立一個 .gitlab-ci.yml 檔案,用於定義 GitLab CI/CD 的設定
  • GitLab Runner 已經安裝並註冊到 GitLab 伺服器,執行 GitLab Runner 的機器上需要安裝 jq 工具。

如何設定 Gitlab CI/CD

要使用 Gitlab CI/CD 自動遞增版本號並 push 到儲存庫,我們需要進行以下幾個步驟:

  1. 在專案根目錄下建立一個 .gitlab-ci.yml 檔案,這是一個宣告式的檔案,用於定義 Gitlab CI/CD 的流程和任務。
  2. 在 .gitlab-ci.yml 檔案中定義一個 deploy 階段,用於執行更新版本號的操作。
  3. 在 deploy 階段中使用 jq 命令列工具來變更版本號。
  4. 在專案設定中啟用 Gitlab CI/CD,並新增相應的環境變數。

這裡我們假設專案已經有版本號,並且存放在package.json檔案中。如果沒有,請依照自己專案的情況進行調整。

例如:

{
  "name": "my-app",
  "version": "1.0.0",
  // 其他字段
}

另外,我們還需要在專案設定中新增以下環境變數:

  • GitLab_Access_Tokens: 在專案設定 -> Access Tokens 中建立一個 Access Token,並將其值指定給這個環境變數。

這些環境變數可以在專案設定 -> CI/CD -> Variables 中新增,並且可以選擇是否設為受保護(Protect)或遮罩(Mask)。

下面是一個範例 .gitlab-ci.yml 檔案:

stages:
  - deploy

master-deploy:
  stage: deploy
  only:
    - master # 只有master更新的时候才执行命令
  except:
    - /^Increment version number to/ # 避免触发以 "Increment version number to" 开头的提交
  script: # 执行的命令
    - chmod +x ./version_update.sh # 赋予脚本执行权限
    - ./version_update.sh # 运行自动更新版本号脚本
  

下面是一個範例 version_update.sh 檔案:

#!/bin/bash

# 从 package.json 中提取当前版本号
current_version=$(jq -r '.version' package.json)

# 分割版本号
IFS='.' read -ra version_parts <<< "$current_version"

# 递增修订号
((version_parts[2]++))

# 重新构建新版本号
new_version="${version_parts[0]}.${version_parts[1]}.${version_parts[2]}"

# 更新 package.json 中的版本号
jq ".version = \"$new_version\"" package.json > temp.json
mv temp.json package.json

# 提交版本号更新
git config user.name "your-name"
git config user.email "your-email"
git remote add gitlab_origin https://oauth2:$GitLab_Access_Tokens@your-gitlab-host.com/your-username/your-repo.git
git add package.json
git commit -m "Increment version number to $new_version"
git push gitlab_origin HEAD:master -o ci.skip

如何驗證結果

當我們提交程式碼後,Gitlab CI/CD 就會自動觸發並執行 .gitlab-ci.yml 檔案中定義的任務。我們可以在專案頁面 -> CI/CD -> Pipelines 中查看流程的狀態和日誌。