GitHub Action으로 Release 자동화 + Slack 연동 + Release/Tag 자동으로 만들어 주기

April·2024년 4월 2일
CI/CDgitgithubgithub actiongithub worlflowrelease tagslack깃헙 워크플로우자동화
2

Git

목록 보기
7/7
post-thumbnail

☐ 들어가며

1분기 개발팀 이니셔티브 중 하나인 형상 관리 표준화 및 전파 작업! 주요 내용은

  • 개발 본부의 표준 깃전략 확정
  • 개발 본부의 표준 커밋 컨벤션 확정
  • 개발 본부의 표준 PR 규칙 확정

이다.

깃 전략 및 깃허브 워크플로우 전략 등이

  • 각 직무별(서버, 웹 프론트엔드, 안드로이드, iOS)로 다르고
  • 해당 직무의 레포지토리(스플, 헬봇 등)별로 또 달라서
  • 같은 웹 프론트엔드 개발자라 하더라도 어떤 서비스를 담당하느냐에 따라 깃, 배포 전략 등을 새로 익혀야 하고
  • 새로 입사한 개발자의 온보딩 시간을 고려하고
  • 개발팀 역량강화 차원에서

해당 이니셔티브를 진행하게 되었다.

그 중 Web Workflow 표준화 작업을 담당하게 되어 작업 히스토리와 결과 산출물을 기록해본다



☐ 깃헙 워크플로우 동작

▪︎ main

name: (서비스명) deploy-prod
on:
	push:
	branches:
		- main # 배포 브랜치
    
    jobs:
      deploy:
        runs-on: ubuntu-latest
    
        steps:
          - name: Checkout
            uses: actions/checkout@v2
    
          - name: Setup Environment
            uses: pnpm/action-setup@v3
            with:
              version: 8 
          - name: Install Dependencies
            uses: actions/setup-node@v3
            with:
              node-version: '18.x' # node-version-file: '.nvmrc'
          - name: Build
            run: |
              pnpm i
              pnpm build
    
        
      # 슬랙 알림
      slack_notifications:
        runs-on: ubuntu-latest
        # 배포 결과 슬랙 알림
        steps:
          - name: Notify Deployment Failure
            if: ${{ failure() }}
            uses: slackapi/slack-github-action@v1.23.0
            with:
              payload: |
                {
                  "attachments": [
                      {
                        "title": "❌ 배포 실패했습니다 🥲",
                        "author_name": "${{github.actor}} 님의 배포 에러 😱",
                        "color": "danger",
                        "fields": [
                          {
                            "title": "Branch",
                            "value": "${{github.ref}}",
                            "short": true
                          },
                          {
                            "title": "Event",
                            "value": "${{github.event_name}}",
                            "short": true
                          },
                          {
                            "title": "Actions URL",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}/checks|${{github.workflow}}>",
                            "short": true
                          },
                          {
                            "title": "Commit",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}|Commit Link>",
                            "short": true
                          },
                          {
                            "title": "Message",
                            "value": "${{github.event.head_commit.message}}",
                            "short": false
                          }
                        ]
                      }
                    ]
                }
            env:
              SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
              SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
    
          - name: Notify Deployment Success
            uses: slackapi/slack-github-action@v1.23.0
            with:
              payload: |
                {
                  "attachments": [
                      {
                        "title": "✅ 배포 완료되었습니다! 👍",
                        "author_name": "${{github.actor}} 님! 성공적으로 배포되었습니다.🎉",
                        "color": "adff2f",
                        "fields": [
                          {
                            "title": "Branch",
                            "value": "${{github.ref}}",
                            "short": true
                          },
                          {
                            "title": "Event",
                            "value": "${{github.event_name}}",
                            "short": true
                          },
                          {
                            "title": "Actions URL",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}/checks|${{github.workflow}}>",
                            "short": true
                          },
                          {
                            "title": "Commit",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}|Commit Link>",
                            "short": true
                          },
                          {
                            "title": "Message",
                            "value": "${{github.event.head_commit.message}}",
                            "short": false
                          }
                        ]
                      }
                    ]
                }
            env:
              SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
              SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
    
      # 배포 후 릴리즈 태그 생성
      release:
        needs: deploy # deploy 성공하면 실행해라
        runs-on: ubuntu-latest
    
        steps:
          - uses: actions/checkout@v2
    
          # package.json에서 버전 정보 추출
          - name: Get Package.json Info
            id: info
            uses: jaywcjlove/github-action-package@main
          - run: echo "version - ${{ steps.info.outputs.version }}"
    
          - name: Get Latest Release Tag
            uses: actions-ecosystem/action-get-latest-tag@v1
            id: get-latest-tag
            with:
              semver_only: true
    
          - name: Create Release
            uses: actions/create-release@v1
            env:
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
            with:
              tag_name: ${{  steps.info.outputs.version }}
              release_name: ${{  steps.info.outputs.version }}
              body: |
                ${{ github.event.head_commit.message }}
    
                **Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ steps.get-latest-tag.outputs.tag }}...${{ steps.info.outputs.version }}
    
      # release, hotfix 배포 후 개발 배포도 동시에 되게끔 develop 브랜치에 머지
      back-merge-to-develop:
        needs: deploy # deploy 성공하면 실행해라
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
    
          - name: Merge main → develop
            uses: devmasx/merge-branch@master
            with:
              type: now
              from_branch: main
              target_branch: develop # 개발 배포 브랜치
              github_token: ${{ secrets.GITHUB_TOKEN }}

▪︎ release : Push - 개발 테스트, 운영 테스트 배포

# Github Flow 전략에선 release 브랜치가 불필요한 경우가 많다.
# 따라서 아예 분기하지 않는 경우가 일반적이다.
    
# ...
    
# develop 브랜치에 머지
 back-merge-to-develop:
	needs: deploy # deploy 성공하면 실행해라
 	runs-on: ubuntu-latest
 	steps:
		- uses: actions/checkout@v2
		
        - name: Merge main → develop
 		  uses: devmasx/merge-branch@master
          with:
            type: now
            from_branch: main # merge 시작할 브랜치
            target_branch: develop # 개발 배포 브랜치
            github_token: ${{ secrets.GITHUB_TOKEN }}

▪︎ hotfix: Push - 운영 테스트 배포

# hotfix PR merge 후 배포 브랜치 merge 후 배포 
# Github Flow 전략에선 hotfix를 사소한 기능 변화로 바라본다.
# 마찬가지로 아예 분기하지 않는 경우가 많다.
    
# ...
    
# develop 브랜치에 머지
back-merge-to-develop:
  needs: deploy # deploy 성공하면 실행해라
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v2
    
    - name: Merge main → develop
      uses: devmasx/merge-branch@master
      with:
        type: now
        from_branch: main # merge 시작할 브랜치
        target_branch: develop # 개발 배포 브랜치
        github_token: ${{ secrets.GITHUB_TOKEN }}

▪︎ PR 시 공통: Style, UnitTest (각 단계마다 범위가 강화되는)

# 모든 PR 체크
name: Check PR
on: [pull_request]
    
jobs:
  build:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout
        uses: actions/checkout@v2
    
      - name: Setup Environment
        uses: pnpm/action-setup@v3
        with:
          version: 8
      - name: Install Dependencies
        uses: actions/setup-node@v3
        with:
          node-version: '18.x' # node-version-file: '.nvmrc'
    
      - name: Check Lint
        run: |
          pnpm i
          pnpm lint
        env:
          CI: true
    
      # 테스트 코드 실행 결과 보여주기       
      - name: Run Tests and Create Comment         
        uses: actions/github-script@v6
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const script = require('./test-result-commit.js')
            console.log(script({github, context}))
    
      # 결과 슬랙 알림
      - name: Notify PR🎁 Check Failure
        if: ${{ failure() }}
        uses: slackapi/slack-github-action@v1.23.0
        with:
          payload: |
                 {
                  "attachments": [
                      {
                        "title": "❌ ${{ github.event.pull_request.title }} << 다시 확인해주세요! 🥲",
                        "author_name": "${{github.actor}} 님의 PR 에러 발생 😱",
                        "color": "danger",
                        "fields": [
                          {
                            "title": "Title",
                            "value": "${{ github.event.pull_request.title }}",
                            "short": true
                          },
                          {
                            "title": "Actions URL",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}/checks|${{github.workflow}}>",
                            "short": true
                          },
                          {
                            "title": "Commit",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}|Commit Link>",
                            "short": true
                          },
                          {
                            "title": "Message",
                            "value": "${{github.event.pull_request.html_url}}",
                            "short": false
                          }
                        ]
                      }
                    ]
                }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
    
      - name: Notify PR🎁 Check Success
        uses: slackapi/slack-github-action@v1.23.0
          with:
              payload: |
                {
                  "attachments": [
                      {
                        "title":  "PR🎁: ${{ github.event.pull_request.title }}",
                        "author_name": "${{github.actor}} 님의 PR🎉",
                        "color": "adff2f",
                        "fields": [
                          {
                            "title": "Commit",
                            "value": "<${{github.server_url}}/${{github.repository}}/commit/${{github.sha}}|Commit Link>",
                            "short": true
                          },
                          {
                            "title": "Message",
                            "value": "${{github.event.pull_request.html_url }}",
                            "short": false
                          }
                        ]
                      }
                    ]
                }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK


:추가

💡 테스트 코드가 통과해야 merge 가능하도록 Github repository 설정하기


▪︎ 설정하기

  1. Repository Settings → Branches → Add rule 을 선택

  2. Branch name pattern 을 설정하고 Require status checks to pass before merging 설정을 통해 merge를 위해 통과해야할 Action들을 선택할 수 있다

☐ 적용 과정

▪︎ 자동화하고 싶은 것

  • 일단 tag
  • pr 요청 시 lint 체크
  • 테스트 결과도 확인해야 하고
  • 배포 완료/실패시 슬랙 알림
    • 내용도 있음 좋겠지?
  • release, hotfix 후 개발 배포도 자동화

▪︎ 자동화하고 싶은 시점?

  • 각 브랜치에 푸시 시 동작
    • 배포시 Git Tag, Release Note 생성
      1. Git Tag 생성하기
        • 방법1: Release branch가 master/main으로 merge 될때
          • release/1.0.0생성
          • merge commit 으로부터 버전 정보 추출
            # 브랜치로 태그 생성
name: Release Tag
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: 버전 정보 추출
        run: echo "##[set-output name=version;]$(echo '${{ github.event.head_commit.message }}' | egrep -o '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}')"
        id: extract_version_name

      - name: Release 생성
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ steps.extract_version_name.outputs.version }}
          release_name: ${{ steps.extract_version_name.outputs.version }}
        • 방법2: master/main 으로 pr 및 merge 될 때 생성 ✅
          # package.json의 version 정보로 태그 생성
name: Create Release Tag
on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      # package.json에서 버전 정보 추출
      - name: package.json info
        id: info
        uses: jaywcjlove/github-action-package@main
      - run: echo "version - ${{ steps.info.outputs.version }}"

      - name: Get latest release tag
        uses: actions-ecosystem/action-get-latest-tag@v1
        id: get-latest-tag
        with:
          semver_only: true

      - name: Create Release 
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{  steps.info.outputs.version }}
          release_name: ${{  steps.info.outputs.version }}
          body: |
            ${{ github.event.head_commit.message }} 

            **Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ steps.get-latest-tag.outputs.tag }}...${{ steps.info.outputs.version }}
        • 추출된 버전 정보를 통해 tag 생성

  • PR 시 공통: Style, UnitTest (각 단계마다 범위가 강화되는)

    • 일단 lint 체크함. 통과안되면 머지 안됨
                  # 모든 PR lint 체크
              name: Check PR
              on: [pull_request]
              
              jobs:
                build:
                  runs-on: ubuntu-latest
              
                  steps:
                    - name: Checkout
                      uses: actions/checkout@v2
              
                    # pnpm 아닌 경우 제거
                    - name: Setup pnpm
                      uses: pnpm/action-setup@v3
                      with:
                        version: 8
              
                    - name: Node.js Setting
                      uses: actions/setup-node@v3
                      with:
                        node-version: '18.x'
              
                    - name: Check
                      run: |
                        pnpm i
                        pnpm lint
                      env:
                        CI: true

  • 테스트 결과도 확인해야 하고

          # 테스트 코드 실행
      - name: Run tests
        run: |
          pnpm test
      
      - name: Publish Unit Test Results
        uses: EnricoMi/publish-unit-test-result-action@v1
        if: ${{ always() }} # 테스트가 실패하여도 Report를 보기 위해 `always`로 설정
        with:
          files: build/test-results/**/*.xml
      
      - name: 테스트 커버리지 결과 PR에 코멘트 추가하기
        if: always()
        uses: ArtiomTr/jest-coverage-report-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

  • 배포 완료/실패시 슬랙 알림

  • release, hotfix 후 개발 배포도 자동화
          back-merge-to-develop:
            needs: build # deploy 성공하면 실행해라
            runs-on: ubuntu-latest
            steps:
              - uses: actions/checkout@v2
        
              - name: Merge main → develop
                uses: devmasx/merge-branch@master
                with:
                  type: now
                  from_branch: main
                  target_branch: develop # TODO: 브랜치 전략 확인 후 수정
                  github_token: ${{ secrets.GITHUB_TOKEN }}

☐ 논의하고 싶은 것

1) 파일 분리할 것인가? 한번에 작성할 것인가?

  • 각 역할을 하는 파일을 분리하여 관리할 것인가? 아님 한 번에 적용할 것인가?
    • 슬랙 알림 등
    • 파일 분리를 했을 때 작성
      #  package.json의 version 정보로 태그 생성
name: Create Release Tag

on:
  workflow_run:
    workflows: ['deploy'] # deploy workflow 후 실행
    branches: [main]
    types: [completed]

jobs:
  release:
    if: ${{ github.event.workflow_run.conclusion == 'success' }} # 성공했을 때
    runs-on: ubuntu-latest
    • 한 파일에 작성
      #...

back-merge-to-develop:
    needs: build # deploy 성공하면 실행해라
    runs-on: ubuntu-latest

2) 깃 전략

  • 배포 브랜치 등
    • master/develop에 머지되면 배포 PR(운영, 개발 배포) 자동 생성되게끔~~
    • 깃허브 전략 따르기로~~
    • 운영 배포는 master에 머지되면, 개발 배포는 deploy-dev 유지
      • 단, 이름 변경하기
        • master > main 변경하기
        • deploy-dev는 고민해보기

3) 통과해야 merge 가능하도록 Github repository 설정하기를 할 것인가?

  • 테스트 코드 등
  • lint 체크 등 오류 발생 했을 경우 어떻게 해결할 것인가?
    • 스프린트 중에 조치할 것인가
    • 이 룰을 일시적으로 제거해서 merge 할 것인가
  • 담에 논의하기로




profile
April
🚀 내가 보려고 쓰는 기술블로그
이전 포스트

[git] git cherry-pick

0개의 댓글