코드래빗 깃허브 연동

코드 리뷰를 자동으로 해 주는 툴이 있다고 해서 적용해 보았는데요
CodeRabbit 에 먼저 들어갑니다.

여기서 Get a free trial을 클릭합니다.

저는 github와 바로 연동하기 위해 Sign up with Github를 클릭해 주었습니다.

깃허브 내에서 코드래빗을 적용하고 싶은 레포지토리를 연결해줍니다.

연결이 완료되면 왼쪽 메뉴에 대시보드와 여러 세팅이 보입니다.

여기서 Organization Settings -> Configuration 으로 갑니다.
여기서 Review Language를 Korean으로 설정한 다음 오른쪽 위 Apply Changes를 눌러주면 설정 완료입니다.

이제 PR에 코멘트를 달아주는지 확인해 봅시다.

리뷰가 스킵되었네요. Review -> Auto Review 설정을 해 준다면 자동을 리뷰를 해 줄 겁니다.

하지만 제 리뷰는 이미 스킵되었기 때문에 강제로 리뷰를 시켜야겠습니다. 위에 코멘트를 보시면 @coderabbitai review로 강제 리뷰를 할 수 있다고 합니다.

Quote reply로 해당 명령을 치고 comment를 눌러줍니다.

그러면 코드래빗이 pr에 올라간 커밋들을 모두 검사하여 리뷰를 달아줍니다.

코멘트에 대한 답도 해 주는군요.

시퀸스 다이어그램까지 만들어주네요.

변경사항

pr 자동 리뷰가 되지 않은 건 설정을 빼 먹었기 때문입니다.. 먼저 organization settings로 다시 갑니다.

가장 아래 Base Branches 부분에 .* 를 입력하고 엔터를 누른 뒤 apply changes 하면 전체 브랜치에 대한 pr에 자동으로 리뷰하겠다는 뜻입니다.

만약 특정 브랜치에만 리뷰하도록 하려면 feature/* 같이 설정해주시면 됩니다.

또한, coderabbit.yaml로 설정하는 방법도 있습니다. 자신의 프로젝트 루트 폴더에 해당 파일을 추가하면 가능합니다.

language: 'ko-KR'
early_access: false
reviews:
  profile: 'chill'
  request_changes_workflow: false
  high_level_summary: true
  poem: false
  review_status: true
  collapse_walkthrough: false
  auto_review:
    enabled: true
    drafts: false
    base_branches:
      - "/*"
chat:
  auto_reply: true

여기서 원하는대로 수정하여 사용하시면 됩니다!

마치며

자동 코드리뷰를 해 주는 것은 너무 편리한 기능인 것 같습니다. 하지만 ai가 언제나 정답일 수는 없기에 저희 팀에서는 팀원 간 리뷰 후 명령어를 사용하여 코드래빗으로 추가적인 리뷰를 받는 방식을 선택했습니다!