GitLab CI/CD でバージョン番号を自動更新してリリースする

GitLab CI/CD は GitLab をベースにした継続的インテグレーションと継続的デリバリーのサービスで、コードをコミットするたびに、ビルド、テスト、パッケージング、デプロイといった一連のタスクを自動で実行してくれます。本記事では、GitLab CI/CD を使ってバージョン番号を自動でインクリメントし、リポジトリへ push する方法を紹介します。これで手作業でバージョン番号を更新する手間から解放されます。

前提条件

  • GitLab アカウントを持っていて、プロジェクトを作成またはインポートしていること
  • プロジェクトのルートディレクトリに、GitLab CI/CD の設定を定義する .gitlab-ci.yml ファイルを作成すること
  • 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 で、パイプラインの状態とログを確認できます。