GitHub의 Branch protection rules

들어가며

---

오늘은 특정 브랜치에 대한 보호 규칙을 설정하여 코드 변경이 안전하게 이루어지도록 해주는 Branch protection rule에 대하여 알아보겠습니다

 

 

 

새로운 룰을 만드는 방법

---

 

1. 원격 저장소의 Settings에 들어갑니다 

 

2. Branches를 클릭 후 Add classic branch protection rule를 클릭합니다

 

3. 아래의 옵션 중 필요한 것을 설정한 후 Create를 눌러주면 됩니다

 

 

 

1. Branch name pattern

---

1. 아래의 상자에 규칙을 적용하고자 하는 브랜치의 이름을 입력합니다

/ 기호를 이용하여 경로를 지정하거나 * 기호(와일드카드)를 단독 혹은 앞뒤로 이용할 수 있습니다 

 

 

 

2. Require a pull request before merging

---

1. 이 옵션을 이용하여 머지하기전 풀 리퀘스트를 생성하여 승인될 경우 수정 내용을 반영합니다

Require approvals

이 옵션을 활성화하면 일정 이상의 인원이 승인해야만 머지가 진행 됩니다(인원수 조절 가능)

 

Dismiss stale pull request approvals when new commits are pushed

이 옵션을 활성화하고 새로운 변경사항을 승인받고자하는 풀 리퀘스트에 커밋하면 기존의 승인이 취소됩니다

 

Require approval of the most recent reviewable push

이 옵션을 활성화하면 풀 리퀘스트 작성자 자신의 변경 사항을 승인할 수 없습니다

 

 

 

3. Require status checks to pass before merging

---

1. 이 옵션을 활성화하면 머지 이전에 특정한 테스트를 통과하는지 자동으로 검증합니다

 

Require branches to be up to date before merging

이 옵션을 활성화하면 머지 이전에 항상 최신의 브랜치의 코드에서 테스트가 진행됩니다

 

 

 

4. Require conversation resolution before merging

---

이 옵션을 활성화하면 풀 리퀘스트에 남겨진 모든 코멘트와 대화가 해결되어야만 머지가 진행됩니다

 

 

 

5. Do not allow bypassing the above settings

---

이 옵션을 활성화하면 관리자 권한을 가진 유저도 위의 설정을 따라야만 하도록 합니다

 

 

 

마무리

---

1. Settings의 Branches를 들어가면 설정한 rule이 설정 되어있음을 알 수 있습니다

2. 하지만 Upgrade(4$) 하지않는다면 개인 저장소의 규칙은 적용되지않기때문에 유의해야합니다

 

 

마치며

---

오늘은 기초적인 수준에서의 룰을 추가하고 옵션을 수정하는법을 배워보았습니다

다루지 못한 옵션들도 있지만 프로젝트의 규모가 커져감에 따라서 사용하게 될 옵션들이 분명히 있을것입니다

 

올바르지못한 내용은 댓글로 알려주시면 수정하겠습니다