GITHUB protected branch를 설정 해 보자

Protected Banch란?

 GITHUB 에서 어떤 브랜치를 어떤 행위에 대해서 보호하기 위한 조치이다. 예를 들어 우리의 소중한 마스터 브랜치는 언제나 잘 작동하는 올바른 코드가 올라가야 할 것이다. 이 원칙을 지키기 위해 마스터 브랜치에는 항상 올바른 커밋 혹은 머지가 되어야 할 것이다. 그래서 깃 허브는 코드를 적용 하기 전 안전 장치로 protected branch라는 것을 마련 해 두었다. 우리는 이러한 브랜치를 보호하기 위해서 브랜치들에 대해 protection rule들을 설정 해 줄 수 있다.

 

GITHUB Repository - > Settings - > Branches 에 가면 다음과 같은 화면을 볼 수 있을 것이다.

Branch protection rule 의 오른쪽에 있는 Add rule 버튼을 클릭하자.

settings/branches

 

Add rule 버튼을 누르면 아래와 같은 화면을 볼 수 있는데 

Branch name pattern 에는 protection을 걸고 싶은 브랜치의 이름을 적도록 하자. 

 

그리고 나서 Protect matching branches를 선택 하면 해당 브랜치에 어떤 옵션을 적용 할 지 선택 할 수 있다!

우리 N poem 프로젝트 에서 설정한 protection rule은 다음과 같다.

- Required pull request reviews before merging : 풀 리퀘스트를 머지를 하기 전 코드 리뷰를 거쳐야 한다.

- Require status checks to pass before merging : CI 테스트를 통과한 브랜치만이 머지 할 수 있다.

   ㄴ 현재는 CI테스트가 준비 되어 있지 않아 구체적인 설정은 미뤄두었다.

 

위 처럼 설정을 마치고 나면 아래 보이는 사진처럼 protection rule에서 요구 하는 2명의 리뷰어가 approve를 하지 않았기 때문에 merge가 block된 모습을 볼 수 있다.

(해당 merge request의 administrator가 본인이기 때문에 무시하고 머지를 진행 할 수는 있지만 해당 부분도 설정을 통해 제한을 둘 수 있다.)

 

https://github.com/paywteam/npoem-server

paywteam/npoem-server