release 브랜치 merge시 Tag 생성, 브랜치 삭제하기 (feat. Gihtub Action)

최근에 상권님의 포스팅을 보고나서 기존 프로젝트의 배포에 대한 추가 자동화를 진행했다.

• 앱 배포후 Jira에서 버전 Release처리 자동으로 하는 방법(feat. GitHub Action)

상권님의 포스팅에서는 다음과 같이 Github Action 의 자동화를 구성하셨다.

• Master 브랜치에서 Push가 발생하면
  • PR Merge 가 되어도 Master 에서는 Push가 발동된다
• Merge Commit으로 발생한 커밋 메세지에서 버저닝 번호만 추출해서 Tag로 생성

반면에 우리 프로젝트는 release 브랜치의 반영이 다음과 같이 진행된다.

그래서 그대로 적용할수는 없었고, 우리팀 스타일에 맞게 개조가 필요했다.

• maaster Push가 아니라 PR이 merge가 되었을때만 Github Action이 작동하기
  • 상권님의 Github Action에서는 master Push에서는 전부 Action이 실행 된다.
  • 현재 우리팀의 규칙에서는 모든 Push 를 실행 기준으로 삼지 않았다.
• release 브랜치명에서 버전 추출하기
  • release -> master로 반영할때 Merge Commit을 생성하지 않는다.
  • 그래서 Merge Commit Message에서 버전을 추출할 수가 없다.

(-ff 로 merge 를 진행하며, merge commit 을 남기진 않는다.)

그래서 크게 2가지 다른 점이 있기 때문에 이 2가지를 우리 쪽 규칙에 맞게 변경했다.

• release 브랜치가 master 브랜치로 Merge 될 경우에만 release 브랜치의 이름으로 Tag/Release 생성
• Merge가 되면 release 브랜치 삭제
  • 이 부분은 Github Action이 아니고, Github 기본 기능으로 지원된다

1. 브랜치명 추출하기

먼저 브랜치명 추출하기부터 진행한다.

해당 작업은 branch-names 을 사용한다.

해당 Action으로 브랜치명이 잘 추출되는지 검증한다.

간단하게 workflow를 하나 생성한다.

코드는 다음과 같다.

name: echo branch Name
on:
  push:
    branches:
      - master
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Get branch names
        id: branch-name
        uses: tj-actions/branch-names@v4.9

      - name: 버전 정보 추출(from Branch Name)
        run: echo "TAG=$(echo '${{ steps.branch-name.outputs.current_branch }}')" >> $GITHUB_ENV

      - name: echo current branch name
        run: echo "current branch name - ${{ env.TAG }}"

핵심 로직은 다음과 같다.

• echo "TAG=$(echo '${{ steps.branch-name.outputs.current_branch }}')" >> $GITHUB_ENV
  • 현재의 브랜치를 TAG 라는 Github 환경 변수에 저장한다.
  • 이렇게 저장된 환경 변수는 ${{ env.TAG }} 와 같이 다른 Step에서 사용할 수 있다.
  • 실제 release 브랜치에서 버전을 추출한 것은 아니다.
  • 이는 아래 코드에서 진행한다.

저장된 환경변수 값이 잘 출력되는지 확인해본다.

브랜치명 추출 작업이 잘 되는것이 확인되었으니 본격 작업에 들어간다.

2. Tag/Release 생성을 위한 Github Action 작성하기

다음과 같이 release.yml workflow 파일을 생성하고, 다음과 같이 yml을 작성한다

name: Release
on:
  pull_request:
    branches:
      - master
    types: [ closed ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Get branch names
        id: branch-name
        uses: tj-actions/branch-names@v4.9

      - name: 버전 정보 추출(from Branch Name)
        run: echo "TAG=$(echo '${{ steps.branch-name.outputs.current_branch }}' | egrep -o '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}')" >> $GITHUB_ENV

      - name: Release & Tag 생성
        if: github.event.pull_request.merged == true
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ env.TAG }}
          release_name: ${{ env.TAG }}

위 코드를 해석하면 다음과 같다

on:
  pull_request:
    branches:
      - master
    types: [ closed ]

• 공식적으로 Github Action에는 PR Merge on type이 없다
• 그래서 on type에서는 Pull Reqest Closed 를 기준으로 둔다.
  • 그 아래에서 각 Step에 if로 merge 를 걸러낸다

- name: Release & Tag 생성
  if: github.event.pull_request.merged == true
  uses: actions/create-release@v1

• if 를 통해 pull request가 merge 되었을때만 Tag와 Release 가 생성되도록 한다.
• 해당 조건이 없으면 Merge가 아닌 모든 closed 이벤트에서 Tag 생성과 Release 생성이 진행되니 필수로 추가한다

이렇게 작성이 완료되었다면 Tag와 Release 생성에 대한 작업은 끝났다.

3. Merge된 release 브랜치 삭제

Merge된 release 브랜치 삭제에 대한 Github Action이 별도로 필요하진 않다.
이미 Github 에서 해당 기능을 제공하기 때문이다.

• Github 공식 문서

모든 설정이 끝났다면 이제 검증해본다.

4. 검증

release 브랜치를 master에 merge하고 Tag/Release 생성과 release 브랜치가 잘 삭제되었는지 확인한다.

Tag 생성

Release 생성

브랜치 삭제