Github Flow

브랜치 관리 방법

• 브랜치 파생은 반드시 최신 main/master브랜치에서 분기시킨다.
• PR 비교 대상 브랜치를 feat/* → main/master 로 설정한다.
  • 핫픽스의 경우 fix/* → main/master로 설정한다.
• 기능 개발이 아닌 코드, UX 등의 개선 브랜치는 refactor/* 브랜치로 작업한다.
• 사용 브랜치

병합 전략

• PR의 검토가 완료되면 PR 생성자는 main 브랜치에 squash and merge로 병합한다.

• 원격 레포의 브랜치와 로컬 레포의 브랜치에서 base 커밋 히스토리가 달라질 경우 원격 레포의 브랜치로 rebase 하여 PR을 생성한다.

  • A라는 사람이 PR이 승인되어 머지하여 main 브랜치는 a→b→c가 되었다고 가정하자.
  • B라는 사람은 feat/기능개발 이라는 브랜치에서 작업하여 히스토리가 a→b→d→e라고 가정하자.
  • main 브랜치와 feat/기능 개발 브랜치는 히스토리가 다르기에 충돌이 발생할 가능성이 높다.
  • 이럴 경우, feat/기능 개발 브랜치의 히스토리가 a→b→c→d’’→e’’이 되도록, rebase해야 한다.

  rebase 방법
  
  현재 체크아웃 된 브랜치가 feat/기능개발 이라고 가정한다.
  
  git fetch origin main //원격 레포의 main 브랜치 가져오기
  git rebase origin/main //가져온 원격 레포의 main브랜치로 base 설정하기
  
  위의 두 명령어 입력 후 conflict 발생 시 충돌을 해결한 후 다음 명령어를 입력한다.
  
  git add . // 변경사항 스테이징 영역에 올리기
  git rebase --continue // 충돌 이후 다시 rebase 시도
  
  만약, rebase를 중지하고 싶다면 git rebase --abort 명령어를 입력하여 취소한다.
  
  위 작업이 완료된 이후, PR을 올리면 브랜치 충돌이 해결된다.
  

  • 다른 사람이 나보다 먼저 커밋하거나 PR을 올릴 때도 위의 예시를 적용하면 된다.

• 만약, 같은 파일을 수정하여 conflict가 발생할 경우 일반 Merge로 컨플릭트 해결 후 PR을 병합하면 된다.

특정 상황 별 Git 사용 예시

로컬 브랜치의 내용을 원격 브랜치 내용으로 덮어 씌우고 싶을 때

• main 브랜치를 덮어 씌운다고 가정

git fetch origin main // 원격 레포의 main 브랜치 가져오기
git checkout main // 내 로컬에 main 브랜치로 Head 포인터 이동
git reset --hard origin/main // 로컬 main 브랜치의 브랜치 포인터를 원격 main 브랜치로 이동

작업 도중 로컬에서 PR 내용을 검토해야 할 때

• git stash 명령어를 입력하여 변경사항을 임시 저장한다.
  • 커밋을 해도 상관 없지만, 보통 커밋하기 전에 검토할 상황이 많이 나온다.
• Pull로 가져올 경우 충돌이 날 가능성이 있기에 가급적 아래 예시로 하는 걸 추천한다.
• 검토할 브랜치를 feat/Modal이라고 가정한다.

git checkout -b feat/Modal // 현재 체크아웃된 브랜치와 관계없이 새로 만들어서 이동하거나 이미 브랜치가 존재한다면 만들지 않고 이동하면 된다.
git fetch origin feat/Modal // 원격 레포의 feat/Modal 브랜치를 가져온다.
git reset --hard origin/feat/Modal // 내 로컬의 브랜치를 원격 브랜치로 덮어 씌우는 작업