Github Actions로 Issues Assignees 자동화하기

개요

Github Actions를 이용해서 자동으로 이슈의 댓글에 특정 키워드가 들어가면 해당 댓글 작성자를 Assigneess로 등록하기

 

❓ 왜 도입하려고 했는가

2021년을 맞이하면서 이번 주에 나는 얼마나 장작을 태웠는가? 스터디에 참여했다. 이곳에서는 매주 3가지 목표를 완료하고 나서 PR을 날린다. 그러면 세명의 리뷰어가 자동으로 지정이 되고 피드백을 받고 머지되는 형식이다.

리뷰어 세명이 자동으로 지정되는게 좋아 보였다. 현재 하고 있는 스터디에도 적용하고 싶었다. 적용하면 이슈의 필터 기능을 통해 참여한 이슈를 볼 수 있어서 좋을 거 같았다. 하고 싶으면 뭐다? 해본다. ㅋㅋ

 

하면서 알게된 사실인데 Github의 teams를 이용하면 코드 리뷰어를 랜덤으로 지정할 수 있다. [참고]

 

🤯 삽질과 삽질

그래서 처음에는 검증도 안 해보고 무작정 스터디 저장소에 적용해봤는데 동작을 안 했다.

이때 스터디 슬랙에서 가장 자주 사용하는 채널에 저장소를 구독하고 있었는데 내가 작업한 것들이 메시지로 와서 채팅이 도배되는 모습을 보고 아차 싶었다. 그래서 원격 저장소 알림용 채널을 따로 만들었다. 지금도 운영하고 있는 학교 공지사항 봇 사건이 생각났다. (잠깐 고장 났었을 때 고친다고 테스트 계정이 아니라 운영하고 있는 봇으로 메시지를 다량 발송했었다.) 슬랙 알림 테러를 받은 스터디원들에게 심심찮은 사과를 전합니다... 뎨동합니다 흑흑

그 후로 개인 리포지토리에 만들어서 작업을 했다. 월요일 오후 8시부터 자정까지, 그다음 날 오후 3시부터 8시까지... 중간에 안 되는 줄 알고 되는 기능만 먼저 적용했었는데! 다 만들어서 테스트까지 하고서 적용했다.

아무튼 관련된 한글 자료가 별로 없어서.. 나랑 비슷한 용도로 자동화하고 싶은 사람을 위해 글로 기록해본다.

테스트해본다고 쌓인 불필요한 커밋 흔적들. 지금은 삭제했다.

정말 다행히도 Github Actions는 공식 문서가 잘 정리되어 있었고, 다른 개발자들이 잘 만들어놓은 것들을 가져다가 활용하면 됐다.

처음 써봐서 어려웠다.

이 글에서는 Issues Helper를 사용한다.

 

💬 이슈의 댓글에 특정 키워드가 들어가면 해당 댓글 작성자를 Assigneess로 등록하기

Issues Helper에서 제공하는 기능 중에 find-comments와 add-assignees를 이용해서 만들었다.

name: 에는 워크플로우의 이름을 작성한다. 나중에 Actions 탭에서 여러 개의 워크플로우를 식별할 때 쓰인다.

on: 에는 워크플로우의 트리거가 되는 이벤트가 들어간다. 나는 이슈의 코멘트가 생성되었을 때 워크플로우가 실행되게 작성했다.
이밖에도 push 되었을 때, pull request가 왔을 때, fork 했을 때 등등 다양한 이벤트들이 있다. 더 많은 이벤트는 Events that trigger workflows 문서에서 확인할 수 있다.

jobs: 밑으로 이제 해야 할 일들을 작성하면 된다.

find-comments의 사용법

find-comments + create-comment + update-comment 활용

body-includes: 에는 댓글 내용에 찾고자 하는 키워드를 적는다. 나는 댓글에 링크가 있는지 판별하고 싶어서 http를 키워드로 작성했다.

outputs: 에 들어가는 건 다른 job에 값을 넘겨줄 때 사용한다. ${{ needs.job1.outputs.xxx }} 형태로 접근이 가능하다. 여기서는 지정 키워드가 들어간 댓글 정보를 넘긴다.

기본적으로 job은 병렬적으로 실행되는데, needs: 에 해당 job이 실행되기 전에 처리해야 하는 job을 명시할 수 있다.

job2 에서는 job1에서 가져온 댓글 목록 중에 가장 마지막 댓글 정보의 작성자를 필터링한다. 필터링을 할 때 jq를 사용했는데, -r 옵션을 붙여주면 문자열 형태로 변환한다.

print 작업은 확인 차 만들어 놓은 부분이고 없어도 무방하다. job3에서는 job2에서 필터링한 댓글 작성자를 해당 이슈의 assignees로 등록한다.

스터디 저장소에 적용된 사진

 

😶 여담

남이 만든 걸 조합해서 만들었지만, 그래도 재미있었다. 만들고 나니 뿌듯하다. 이래서 다들 자동화하는 걸까?

Issue-Helper 뿐만 아니라 다른 앱을 이용하면 특정 Label에 특정 사람 assignees로 추가하기, 풀 리퀘스트에 리뷰어 지정하기 등을 적용할 수 있다. 생각보다 어렵지 않으니 지금까지 직접 적용하고 있으신 분들은 직접 만들어봐도 좋을 거 같다.