GitHub Actions 를 활용한 release bot 만들기

 

이번에 사내에서 메일 템플릿을 관리하는 프로젝트의 배포 방식을 변경하는 업무를 맡아 진행하며

Github Action (이하 GHA)을 다뤄볼 기회가 생겼습니다.

GHA로 PR에서 특정 comment 를 남기면, 변경사항을 배포해주는 자동화 프로세스를 만들고 싶었는데

GHA 사용이 처음이라 꽤나 많은 삽질을 해서 비슷한 기능을 구현하고 싶은 분들을 위해 기록을 남기려고합니다.

 

📌 PR comment echo 테스트하기

우선 PR에서 특정 명령어를 담은 댓글을 남기면, 이를 감지하는 workflow 를 작성해보겠습니다.

release 라는 comment 를 남기면 workflow 가 해당 PR 에 댓글로 응답해주는 workflow 를 작성합니다.

comment 추가는 issue_comment event 를 통해 감지할 수 있습니다.

 

comment 생성은 github 의 REST API 를 사용하면 되는데, curl 을 이용하는 대신

github-script action을 사용하면 workflow 에서 JavaScript 를 이용한 REST API 를 호출할 수 있습니다.

 

name: Pull request comment
on:
  issue_comment:
    types: [created, edited]

jobs:
  pull_request_comment:
    runs-on: ubuntu-latest
    if: github.event.issue.pull_request && contains(github.event.comment.body, 'release')
    steps:
      - name: Add comment
        if: contains(github.event.comment.body, 'release') 
        uses: actions/github-script@v6
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: '🚀 release'
            })

 

의도대로 잘 동작합니다.

 

⚠️ 만약 다음과 같은 에러가 난다면..

 

 

createComment 에서 권한 문제가 발생한다면 workflow 의 permission 을 확인해보시면 됩니다.

repository setting > actions > general 에서 변경 가능합니다.

 

read-write 권한을 부여해줍니다.

 

📌 이제 본격적으로 release bot 을 만들어봅시다.

release comment 형식

위에서 작성한 workflow 를 바탕으로 본격적으로 release bot 을 만들어봅시다.

주어진 옵션에 따라 빌드 조건을 다르게 하고 싶었는데, 다음은 그 예시입니다.

 

// 예시 : release-<빌드환경> <옵션> <파일 혹은 디렉토리명>

/release-staging file air-refund
/release-production directory air

 

issue comment trigger 기준에 유의합니다.

기본적으로 issue comment event 는 repository default branch 를 기준으로 workflow 가 실행됩니다.

이번에 구현할 release bot 은 특정 작업 브랜치 PR에서 변경이 발생한 모든 파일들을 조회해서

배포가 필요한 템플릿들을 추출하는 과정이 필요했습니다.

 

이는 곧 main 브랜치 HEAD 와 현재 작업중인 PR 브랜치 HEAD 사이의 모든 변경파일 조회가 필요한 것인데,

이 때문에 comment 를 남긴 타겟 브랜치로 checkout 해줘야합니다.

이를 구현하기 위해 먼저 issue number 로 PR 정보를 불러오고, HEAD SHA 를 이용해서 checkout 합니다.

 

name: release comment
on:
  issue_comment:
    types: [created, edited]

jobs:
  release-comment:
    if: github.event.issue.pull_request && contains(github.event.comment.body, 'release-')
    runs-on: ubuntu-latest

    steps:
      - name: fetch branch
        id: fetch-branch
        uses: actions/github-script@v6
        with:
          github-token: ${{secrets.GITHUB_TOKEN}}
          script: |
            try {
              const pr = await github.rest.pulls.get({
                owner: context.repo.owner,
                repo: context.repo.repo,
                pull_number: context.issue.number
              })

              return pr.data
            } catch (err) {
              core.setFailed(`❌ Request failed with error ${err}`)
            }

      - name: checkout to branch
        uses: actions/checkout@v3
        with:
          ref: ${{ fromJSON(steps.fetch-branch.outputs.result).head.sha }}
          fetch-depth: 0

 

명령어 파싱해서 전달하기

이제 shell script로 command line을 파싱하고 그 결과를 workflow 환경변수로 추가합니다.

 

jobs:
  release-comment:
        // ...

        - name: Define release options
        run: |
          comment="${{ github.event.comment.body }}"
          args=($comment)
          PHASE=$(echo "${args[0]}" | cut -d"-" -f 2)
          TYPE=${args[1]}
          SLUG=${args[2]}
          echo "PHASE=$PHASE" >> $GITHUB_ENV
          echo "TYPE=$TYPE" >> $GITHUB_ENV
          echo "SLUG=$SLUG" >> $GITHUB_ENV

 

이후 배포 옵션에 따른 빌드 스크립트를 실행하도록 step 을 추가해줍니다.

빌드 결과로 발생한 로그들을 output text file 로 함께 출력해주도록 합니다.

 

- name: Release single template
  if: env.TYPE == 'file'
  run: |
    npm run release:${{ env.PHASE }} -- -t FILE -s ${{ env.SLUG }} | tee output.txt

// ... other options

 

comment 생성하기

이제 로그 파일을 한줄씩 읽어서 템플릿 배포 관련 로그들만 추출해서 , 로 구분된 문자열을 만들어주고,

이후 step 에서 이 결과값을 이용해서 테이블 형식의 report comment 를 생성해줍니다.

 

- name: Read report
  id: read-report
  run: |
    messages=()
    // ... "output.txt" 로부터 파일데이터를 읽어 messages 에 배열로 할당하는 쉘 스크립트

    REPORT="$(printf "%s," "${messages[@]}")"
    echo "REPORT="$REPORT"" >> $GITHUB_OUTPUT

- name: Notify release success
  if: success()
  uses: actions/github-script@v6
    with:
    script: |
            try {
            function createReport() {
              const reports = '${{ steps.read-report.outputs.REPORT }}'.split(',')
              // ... reports 로 comment body 를 형식에 맞게 생성해서 반환합니다.
            }

            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: createReport()
            })
          } catch (err) {
            core.setFailed(`❌ Request failed with error ${err}`)
          }

 

잘 동작하네요!

 

HEAD 비교해서 변경된 파일 조회하기

앞서 PR 에서 변경된 템플릿만 추출해서 배포하는 옵션도 추가했다고 했는데, 이를 위해서

실제 서비스 코드에서는 changed-files 를 이용해서 변경된 템플릿 파일 목록을 조회하고

해당 템플릿 코드를 파싱해 의존성을 파악한 뒤 실제 배포 대상 템플릿을 파악하는 모듈을 추가했습니다.

 

📌 참고자료

워크플로를 트리거하는 이벤트 - GitHub Docs

https://github.com/actions/checkout/issues/331