Git 태그 자동 업데이트 ~ 병합되는 주제 분기마다 업데이트 규칙 변경 ~

소개

아무래도! 생산 기술부의 엔지니어입니다. Git 태그를 자동 업데이트 할 수 있도록 GitLab CI로 설정해 보았습니다. 병합되는 토픽 브랜치마다 갱신 룰을 바꿀 수 있는 스크립트를 짜 왔으므로 소개합니다.

GitLab 서버를 처음부터 구축하시는 분은 아래에서 확인하세요.
"프록시 환경에서 Docker Compose를 사용하여 CentOS7에 GitLab Docker 만들기"

전제 조건

GitLab, GitLabRunner의 도입이 실시된 것.

대상 브랜치 모델

다음 브랜치 모델을 사용하여 master 브랜치에 주제 브랜치가 병합될 때 태그를 업데이트합니다. 사용하는 브랜치 모델에 대해서는 여기를 참조해 주세요.



Develop 브랜치에서 병합된 경우와 다른 브랜치에서 병합된 경우로 나누어 태그 업데이트 규칙을 다음과 같이 설정합니다.

Merge branch 'develop' into 'master'
1.0.0 -> 2.0.0
Merge branch 'hotfix' into 'master'
1.0.0 -> 1.0.1

자동 업데이트 스크립트 작성

만들 스크립트를 소개합니다. 만들 파일은

GitLab CI 용 구성 파일 (.gitlab-ci.yml),

병합 이벤트 중에 시작할 스크립트 (release.sh),

태그 업데이트 규칙을 설정하는 스크립트 (version_up.sh)

세 가지입니다.

GitLab CI 설정

.gitlab-ci.yml에는 release_job에 릴리스용 스크립트를 추가하고 릴리스용 스크립트 내에서 태그 업데이트용 스크립트를 시작합니다. master 브랜치에 병합될 때 태그 업데이트를 수행하도록 master 브랜치에만 설정합니다.

.gitlab-ci.yml

stages:
  - develop
  - release
  - hotfix

develop_job:
  stage: develop
  script:
    - echo "develop"
  only:
    - develop

release_job:
  stage: release
  before_script:
    - chmod u+x scripts/release.sh 
  script:
    - scripts/release.sh
  only:
    - master

hotfix_job:
  stage: hotfix
  script:
    - echo "hotfix"
  only:
    - hotfix

병합된 주제 분기를 판별

release.sh는 병합된 주제 분기가 develop인지 아니면 다른지를 결정합니다. 병합되었을 때의 커밋 메시지를 로그 출력해, 토픽 브랜치의 이름을 잘라내고 있습니다. git log --grep "<pattern>" 같은 것을 사용하면 좀 더 깨끗이 쓸 수 있을지도 모릅니다. 잘린 이름이 develop이면 메이저 업데이트, 그렇지 않으면 버그 수정할 수 있도록 version_up.sh에 major/bugfix를 인수에 제공합니다.

아래 샘플은 업데이트되는 태그를 표시하기 전까지 실제로 태그를 지정하지 않았습니다.

release.sh

#!/bin/bash
chmod u+x scripts/version_up.sh

# マージ時のgit logからトピックブランチのブランチ名を切り出す
merged_branch_name=$(git log --pretty=oneline --abbrev-commit --merges -n 1 | awk '{print $4}' | sed 's/'\''//g')

# ブランチ名がdevelopだった場合はメジャーアップデート、それ以外はバグフィックス
if [ $merged_branch_name = "develop" ]; then
  git tag -l | tail -n 1 | scripts/version_up.sh major
else
  git tag -l | tail -n 1 |  scripts/version_up.sh bugfix
fi

태그 업데이트 규칙 설정

태그 업데이트 스크립트( version_up.sh )는 신속의 「git으로 태그명에 날짜를 포함하고 있는 것은 다사」 을 참고로 작성하였습니다. 업데이트 규칙은 주요 업데이트, 사소한 업데이트 및 버그 수정에만 적용되었습니다.

version_up.sh

#!/bin/sh
version=`awk '{print $1}' < /dev/stdin`
command=$1
major=`echo $version | awk -F '.' '{print $1}'`
minor=`echo $version | awk -F '.' '{print $2}'`
bugfix=`echo $version | awk -F '.' '{print $3}'`

if [ -z "$version" ]; then
  echo "USAGE: echo 1.0.0 | version_up.sh [major|minor|bugfix]"
  exit 1
fi

if [ "$command" = '' ]; then
    bugfix=`expr $bugfix + 1`
elif [ "$command" = 'major' ]; then
  major=`expr $major + 1`
  minor=0
  bugfix=0
elif [ "$command" = 'minor' ]; then
  minor=`expr $minor + 1`
  bugfix=0
elif [ "$command" = 'bugfix' ]; then
  bugfix=`expr $bugfix + 1`
fi

echo ${major}.${minor}.${bugfix}

마지막으로

태그 자동 업데이트 스크립트가 완성되었습니다. 테스트에 사용한 리포지토리는 여기에 있습니다. 더 스마트한 스크립트가 있으면 알려주세요.

참고

신속의 「git으로 태그명에 날짜를 포함하고 있는 것은 다사」