DEVOCEAN

1. release 자동화가 필요하게된 이유

최근에 개발을 하면서 git의 branch 전략 dev, staging, main(master)를 정의하면서 git branch에 대한 정의를 하였다.

이때 dev, staging, main(master)에서 개발이 완료됨에 따라 CI/CD중 CD에 해당하는 사용자(외부로) 노출되어야하는 서비스, 제품등 release가 필요한 상황이 생겼다.

release가 주기적으로 일어남에 따라 배포된 내용과 버그픽스, 기능추가등등 문서를 정리해야 할일들이 발견 되었는데 git commit 내용을 취합해서 문서화하는것도 어느정도 귀찮은 상황이 발생하였음.

2. 이때 협업하는 사람들과의 아이디어 접근

github action을 통하여 tag/release를 자동화하면서 문서화까지도 자동화 구축하자

3. 사용하게된 도구

github의 action marketplace에 있는 tag/release 자동화 tool

mathieudutour/github-tag-action@v6.1

ncipollo/release-action@v1

3.1 github action code

github action code 요약설명

github develop branch에 commit후 main으로 pull_request하여 trigger를 동작시켜 deploy하도록 진행

name: github action tag release 

on:
  push:
    branches:
      - main

jobs:
  setup-build-deploy:
    name: Setup, Build, and Deploy
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: write
      id-token: write 

    steps:
    - name: Bump version and push tag
      id: tag_version
      uses: mathieudutour/github-tag-action@v6.1 
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }} 

    - name: Create a GitHub release
      uses: ncipollo/release-action@v1 
      with:
        tag: ${{ steps.tag_version.outputs.new_tag }}
        name: Release ${{ steps.tag_version.outputs.new_tag }}
        body: ${{ steps.tag_version.outputs.changelog }}

3.2 commit 로그

설명1)

github에 commit한 log를 기반으로 release version이 update되면서 commit로그를 바탕으로 배포로그까지 생성이된다

설명2)

init, modify는 버전으로 기록이 되지 않는다

fix:, feat: 두가지의 github log가 기록으로 되어 github tag 버전에 정상적으로 배포로그(하단의 3.4. 참조)가 남게된다

commit 메시지 종류

3.3 github action 실행 결과

main으로 push되었을때 trigger가 됨을 알 수 있다

3.4 배포 결과

위의 3.2 commit로그를 토대로 배포로그가 정상적으로 생성되었으며 semver 형태로 버전이 정상생성됨을 알 수 있다.

4. 회고 및 후기

실제로 commit 로그를 토대로 배포로그를 생성해줌으로 동시작업한 github시 불필요작업이 줄어들었음을 알 수 있다.

github action workflow를 여러개 작성했을시 release는 project에서 1개로 관리됨에 따라서 버전이 여러개 올라가는 경우를 볼 수 있다.