Github PR Reviewer 자동 추가하기

팀 문화 중 코드 리뷰 문화를 개선하면서 코드 리뷰의 활성화를 위해 PR 진행 시 팀의 모든 인원을 Reviewer로 추가하기로 했습니다. 기존에는 팀장에게만 리뷰가 걸렸지만 코드 리뷰의 방식이 바뀌어 팀의 모든 인원을 계속 걸어줘야 하다 보니 번거로움이 생겼습니다. 그래서 PR 생성 시 자동으로 Reviewer가 걸리도록 Github Code owners에 대해 알아보고 적용하게 되어 해당 내용을 정리하게 되었습니다.

 

Code owners?

Github Code owners는 repository에 owner로 지정하여  PR 생성 시 지정된 owner들이 자동으로 Reviewer로 걸리게 합니다. Github Code owners 관리는 CODEOWNERS 파일로 하며 개인 또는 팀을 지정할 수 있습니다.

 

Code owners 설정

repository 루트에 .github 디렉토리를 생성하고 해당 디렉토리 내부에 CODEOWNERS 파일을 생성합니다. Github의 username과 team 명을 이용하여 owner로 지정하며 Github email로도 지정 가능합니다. 그리고 repository 전체뿐만 아니라 특정 파일의 확장자, 특정 파일 및 디렉토리에도 owner를 지정할 수 있습니다.

# Example CODEOWNERS
# .github/CODEOWNERS

# repository 전체 owner 지정
# 개인에게 owner 지정
* @username

# 다수에게 owner 지정
* @username1 @username2

# email로 owner 지정
* test@example.com

# team에 owner 지정
* @org/team

# 특정 확장자에 owner 지정
*.js @username

# repository에 docs name을 가진 모든 디렉토리에 owner 지정
docs/* @username

# repository에 root의 docs 디렉토리에 owner 지정
/docs/ @username

 

마무리

코드 리뷰 문화를 개선하면서 PR 진행 시 팀원들 모두를 일일이 Reviewer를 걸어줄 필요 없이 Github Code owners로 간단하게 해결할 수 있었습니다. 좀 더 기능을 찾아보며 팀 내 코드 리뷰 문화를 활성화할 수 있도록 해야겠습니다.

 

---

참고자료

https://docs.github.com/ko/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners