Github Actions 로 리뷰어 자동 할당하기

Kim Dong Kyun·2024년 7월 23일

개요

프로젝트를 진행하면서, 추후 구현에 PR 및 리뷰가 좀 더 적극적으로 이루어졌으면 하는 바램이 생겼다. 그에 따라

1. 리뷰어를 내가 고르지 않아도 돼서 부담이 덜하고
2. 리뷰어에게 깃허브에서 자동으로 보내주는 메일 뿐만 아니라, 소통 채널(ex : 디스코드) 에서의 멘션(알림을 끌 수도 있으니)

이 자동으로 이루어지는 환경이 필요했다. 이 과정에서 협업하고 있는 백엔드, 프론트엔드 모두 사용할 수 있는 통합된 환경을 원했으므로 Github Actions 외 다른 설정이 필요 없는 방식으로 리뷰어 자동 할당 을 구현했다.

예제에서는 현재 팀이 다루고 있는 Discord 를 사용하지만, Slack 등의 다른 알림툴을 사용해도 무방 할 것으로 보인다.

구현

1. 깃허브 토큰 발급

우리가 참여해서 개발하고 있는 특정 Github Repository 에서 풀 리퀘스트가 있을 시

같은 Repository 에서 작업중인 작업자의 목록들을 가져오는 API

이 API 로 리뷰어를 랜덤으로 한 명 추출한다.

추출한 리뷰어에게 리뷰 요청을 보내는 API

이 API 로 리뷰어에게 PR 리뷰를 할당한다.

를 사용해야 하기 때문에, 깃헙에 위 API 요청을 보낼 시 인증 수단으로 사용할 관리자의 개인 토큰이 필요하다.

깃허브 접속 -> 프로필 -> 세팅으로 진입한다.

맨 아래있는 Developer settings 클릭

익숙한 클래식 방식으로 토큰을 생성한다.
토큰을 생성한다.
같은 Repository 에서 작업중인 작업자의 목록들을 가져오는 API
추출한 리뷰어에게 리뷰 요청을 보내는 API

를 호출해야 하므로, admin:repo_hook + workflow(repo 도 자동으로 권한 체크된다) 를 선택해준다

생성된 토큰을 잘 저장해둔다 (어딘가에)

2. Discord Webhook 설정

WebHook?
웹후크를 설정하기 위해 클라이언트는 서버 API에 고유한 URL을 부여하고 알고자 하는 이벤트를 지정합니다. 웹후크가 설정되면 클라이언트는 더 이상 서버를 폴링할 필요가 없습니다. 지정된 이벤트가 발생하면 서버는 클라이언트의 웹후크 URL에 관련 페이로드를 자동으로 전송합니다. - Redhat '웹후크란?'

예제에서는 디스코드를 사용 할 것이기 때문에, 디스코드 웹훅을 발급받아보자.

서버(참여하고 있는) 설정에 들어간다.
좌측 연동 버튼을 클릭한다.
웹후크를 새로 만든다
적절히 웹후크 설정을 마치고 (채널, 프사...) 링크를 클릭하여 발급받는다.

3. Repository secret 설정

깃헙 토큰, 디스코드 웹훅 URL 을 퍼블릭하게 노출시키는 것은 싫기 때문에, Github Actions 사용 시에 유용하게 사용 가능한 Github secret 을 사용한다.

작업 중인 repository 의 Settings -> Scretes and variables -> Actions 에서 New repository secret(녹색 버튼) 을 클릭해서 디스코드 웹훅 URL, 리뷰용 깃허브 인증 토큰을 등록한다.

(GITHUB ... 으로 시작되는 키는 발급이 제한되므로, REVIEW_TOKEN 이라는 이름으로 만들었다)

이제 준비 거~의 끝.

4. Github-actions 스크립트(.yml) 작성

별표친대로
(repo이름)/.github/workflows/만들파일이름.yml

위치에 새 워크플로를 작성한다.

나의 경우는 이미 gradle.yml 이라는 파일이 존재하는데, 이 파일은 CI-CD용으로 main 브랜치에 push 이벤트에 대한 워크플로 파일이고, 우리가 원하는 것은 main 브랜치에 향하는 pull_request 이벤트에 대한 것이므로 둘을 분리했다. (관리나, 책임의 분리 관점에서도 이게 맞다고 생각했다)

4 - 1 간단한 버전

name: Assign Random Reviewer

on:
  pull_request:
    branches:
      - "develop"

jobs:
  assign-reviewer:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v2

    - name: Set up jq
      run: sudo apt-get install -y jq

    - name: Select Random Reviewer
      id: select-reviewer
      run: |
        reviewers=$(curl -s -H "Authorization: token ${{ secrets.REVIEW_TOKEN }}" https://api.github.com/repos/${{ github.repository }}/contributors | jq -r '.[].login')
        reviewer_array=($reviewers)
        random_index=$(($RANDOM % ${#reviewer_array[@]}))
        selected_reviewer=${reviewer_array[$random_index]}
        echo "Selected reviewer: $selected_reviewer"
        echo "::set-output name=reviewer::$selected_reviewer"

    - name: Add reviewer to PR
      run: |
        pr_number=${{ github.event.pull_request.number }}
        reviewer=${{ steps.select-reviewer.outputs.reviewer }}
        curl -s -X POST -H "Authorization: token ${{ secrets.REVIEW_TOKEN }}" -d '{"reviewers":["'"$reviewer"'"]}' "https://api.github.com/repos/${{ github.repository }}/pulls/$pr_number/requested_reviewers"

    - name: Send Discord Notification
      run: |
        webhook_url=${{ secrets.DISCORD_WEBHOOK_URL }}
        reviewer=${{ steps.select-reviewer.outputs.reviewer }}
        pr_number=${{ github.event.pull_request.number }}
        pr_title=${{ github.event.pull_request.title }}
        pr_url=${{ github.event.pull_request.html_url }}

        payload=$(cat <<EOF
        {
          "content": "새로운 PR이 생성되었습니다. [#$pr_number] $pr_title\n@$reviewer 님, 아래 URL에서 PR을 리뷰 해 주세요!\n$pr_url"
        }
        EOF
        )

        curl -X POST -H "Content-Type: application/json" -d "$payload" $webhook_url