[Git] GitHub Branch Protection Rules로 PR 승인 필수 설정하기

들어가며...

• GitHub의 Branch Protection Rules(브랜치 보호 규칙)을 통해 PR 병합 전에 반드시 동료의 승인을 받도록 설정 가능
• 이를 통해 코드 품질을 유지하고, 실수를 방지하며, 협업 과정을 더욱 철저히 관리 가능

 

Branch Protection Rules 설정 위치

1. GitHub 레포지토리 페이지로 이동

2. Settings 탭으로 이동

3. 왼쪽 사이드바에서 “Branches” > “Rules”를 선택

4. New branch ruleset 버튼을 클릭하여 새로운 규칙 세트를 생성

 

순서

1	3
2	4

 

1. 규칙 이름 설정(Ruleset Name)

규칙 세트의 이름을 작성

• 예를 들어 main 브랜치용 규칙이라면 “main 보호 규칙” 등으로 지정

2. 적용 상태 설정(Enforcement Status)

활성(Active)으로 설정하여 규칙이 적용 설정

3. 우회 목록 설정(Bypass List)

특정 사용자가 이 규칙을 우회할 수 있도록 설정

• 예를 들어,Organization Admin,Deploy Keys등의 역할을 가진 사용자가 규칙을 무시하고 푸시할 수 있게 함
• 필요한 경우에만 설정

4. 타겟 브랜치 설정(Target branches)

• Include default branch: 기본 브랜치(예: main 또는 master)만 보호
  • 주로 배포 및 PR의 주요 대상 브랜치인 경우 이 옵션을 선택
• Include all branches: 모든 브랜치에 대해 동일한 보호 규칙을 적용
  • 여러 브랜치에서 동일한 승인 규칙을 강제하고자 할 때 이 옵션을 사용

5. 규칙 설정(Branch Rules)

PR 승인을 필수로 하기 위해 필요한 설정들

• Require a pull request before merging: PR을 통해서만 병합이 가능하도록 설정. 모든 커밋은 PR로 제출된 후 리뷰 과정을 거쳐야 병합할 수 있게 됨
  • Required approvals: PR 병합 전에 필요한 승인 수를 설정
    • 예를 들어, 1로 설정하면 한 명의 승인이 있어야만 병합이 가능
  • Dismiss stale pull request approvals when new commits are pushed: PR에 새로운 커밋이 추가되면 기존 승인이 자동으로 해제
    • 리뷰어가 최신 커밋을 다시 검토하도록 강제하고 싶다면 체크
  • Require conversation resolution before merging: PR에 남긴 모든 리뷰 코멘트가 해결되어야만 병합할 수 있도록 설정
    • 논의된 모든 사항이 해결된 후에만 PR을 병합할 수 있게 하여 코드 품질을 유지