PR Assignee와 Label 자동화하기

들어가기 전에

작년 9월 코드잇 부트캠프에 참여하면서 GitHub Actions를 배우게 되었습니다. 그래서 이번에 백오피스 기능을 담당하게 되면서, 실제 프로젝트에 직접 적용해 보았습니다.

GitHub Actions란

GitHub Actions는 GitHub에서 제공하는 자동화 도구로, 코드가 push되거나 PR이 생성되는 순간처럼 특정 이벤트가 발생했을 때 원하는 작업을 자동으로 실행하도록 설정할 수 있는 기능입니다.

빌드, 테스트, 배포 같은 CI/CD 환경을 구성할 때 많이 사용되지만, 라벨 자동 부여나 코드 스타일 검사처럼 작은 반복 작업을 자동화하는 데도 활용할 수 있어요.

어떤 GitHub Actions를 도입하였는가

이번에 도입한 GitHub Actions는 크게 두 가지이며, PR 생성을 더 편하게 만들어주는 자동화입니다.

• Assignee 자동 부여
• Label 자동 부여

도입한 목적

도입한 목적은 크게 두 가지예요.

• 이전에 배웠던 GitHub Actions를 실제 프로젝트에 적용해보며 배우고 싶어서
• Assignee와 Label을 직접 수동으로 지정해야 하는 번거로움을 줄이기 위해서

적용 방법

레퍼런스가 많아서 적용 자체는 크게 어렵지 않았어요. 매번 PR을 올릴 때마다 Assignee와 Label을 직접 지정해야 하는 번거로움은 저만 느낀 게 아니었나 봐요.

GitHub Marketplace에서 필요한 액션을 검색하면, 이미 잘 만들어진 YAML 템플릿들을 바로 가져다 쓸 수 있어요. 저의 경우는 여러 템플릿 코드와 블로그 글들을 참고해 제 프로젝트에 맞게 작성했습니다.

구조

• .github/workflows/auto-pr-assignee.yml: PR 생성 시 작성자를 자동으로 Assignee로 지정하는 기능
• .github/workflows/labeler.yml: PR 제목 규칙에 따라 Label을 자동으로 부여하는 기능
• .github/labeler.yml: Label 부여 규칙(정규식 패턴)과 자동 코멘트 메시지를 정의하는 기능

자세한 파일 내용은 아래 PR에서 확인할 수 있고, 프로젝트 내 구조는 이렇게 구성해두었습니다 🙌

• Assignee 자동 부여 (https://github.com/snorose/snorose-front-admin/pull/83)
• Label 자동 부여 (https://github.com/snorose/snorose-front-admin/pull/85)

마치며

설정을 적용하고 난 뒤 정기회의에서 팀원이 “이거 종종 잊어버리던 작업이었는데 자동으로 처리돼서 너무 편하다”라고 하더라고요. 작은 자동화지만 팀 작업 흐름이 훨씬 부드러워져서 도입하길 잘했다는 생각이 들었습니다.

최근에는 1년 반 정도 사용해온 커밋 메시지 룰을 팀에서 변경하면서, Husky로 커밋 메시지 패턴을 검증하는 설정도 함께 도입해보려고 해요. 인턴십이나 코드잇 부트캠프에서 접해본 적은 있었지만, 실제로 제가 직접 설정해보는 건 처음이에요. 이번 기회에 직접 적용해보면서 팀 컨벤션을 더 안정적으로 지킬 수 있을 것 같아 기대하고 있습니다:)

참고

• Github Action으로 Labeling 자동화하기
• Github labels github action으로 설정하기
• GitHub Actions로 Pull Request Labeling 자동화하기