협업 시에 이슈 관리자와 리뷰어를 일일이 설정하기 불편한가요?

목차

· 배경

· 깃 액션으로 자동화해보기

---

배경

요즘따라 다양한 프로젝트에서 다양한 개발자들과 많은 협업을 진행하고 있다. 그러다보니 풀리퀘스트 관련 내용들에 대해 코드 리뷰를 진행하고, 풀리퀘스트 템플릿을 통해 다양한 이슈에 대한 머지 과정을 통해 코드에 병합하는 과정을 진행하고 있다. 모든게 괜찮지만 풀리퀘스트 템플릿을 작성하면서 이슈 생성자와 리뷰어를 생성하는 것이 정말 정말 불편하게 다가왔다. 팀원들이 많은게 아니라면 일일이 설정을 할 수 있겠지만 4~5명만 있어도 매 머지 과정에서 다 넣어줘야하는 과정이 생각보다 고역이다 🫨

 

작년에 `깃 액션을 통해 채용 정보들을 자동으로 긁어오는 과정을 경험을 했으니, 이번에도 이런 과정들을 자동화할 수 없을까?` 라는 생각을 했다. 이런 사소한 과정 속에서 효율을 가져오고, 사소한 과정에 모이다보면 작업 시간도 확실히 줄어들 것이기 때문이다. 그래서 깃 액션을 활용하여 풀리퀘스트 템플릿을 올리면, 자동으로 봇이 이슈 생성자와 리뷰어들을 지정해주는 자동화 환경을 만들고자 했다.

깃 액션으로 자동화해보기

사실 개발자들은 보다 편안한 환경을 위해 다양한 것들을 만들고, 다양한 개발자들과 공유하며 같이 발전시키고자하는 좋은 문화를 가지고 있다. 관련하여 깃허브 액션 봇들도 많이 존재하는데 자동으로 리뷰어를 생성해주는 깃 액션 봇도 존재하는 것을 확인했다. 다양한 깃 액션 봇들이 많지만 조금 더 편리하고 효율적인 기능만을 사용하기 위해 아래의 깃허브 봇을 채택을 하였다.

GitHub - hkusu/review-assign-action: GitHub Actions to automatically set assignees and reviewers on pull requests.

해당 깃 액션 실행을 위해 토큰 정보는 사전에 준비를 해두고, 등록을 해두어야한다.

 

.yml로 사용하게 될 코드는 아래와 같다.

name: Review Assign

on:
  pull_request:
    types: [opened, ready_for_review]

jobs:
  assign:
    runs-on: ubuntu-latest
    steps:
      - uses: hkusu/review-assign-action@v1.4.0
        with:
          assignees: ${{ github.actor }}
          reviewers: klmhyeonwoo

 

github.actor은 풀리퀘스트 템플릿을 열어 생성한 사람이 자동적으로 지정이 되어지며, reviewers에서는 필수 리뷰어로 지정할 사람들을 지정하여 생성하면 된다. 해당 파일은 레포지토리의 Actions 탭에서 봇을 .yml 파일을 작성하여 추가할 수 있고, 그게 아니라면 .github 폴더를 생성하여 하위 경로에 직접 파일 추가를 통해 사용할 수 있다.