깃헙 이슈, 마일스톤, 깃플로우

 

📂 이슈와 마일스톤

---

이슈는 말 그대로 처리해야하는 일들.

공통의 성격을 가진 이슈들을 하나의 목표, 달성 기준점으로 묶은 것을 마일스톤이라고 생각하면 된다.

 

 

 

 

📂 적용하기

---

연습하기 위해서 '개발환경 세팅하기'라는 마일 스톤 하나와,

아래의 투두, 진행중에 있는 두 개의 이슈를 설정했다.

아래는 프로젝트에서 볼 수 있는 화면이다.

 

이슈를 생성할 때 마일스톤을 지정할 수 있다.

저어기 이정표 아이콘과 있는 게 마일스톤.

 

 

 

 

푸시-풀리퀘스트 날리며 프로젝트와 마일스톤, 이슈를 설정해줬더니, 저렇게 알아서 초록색으로 꽉 차고 마일스톤이 다 달성 됐다.

 

 

 

 

📂 Git Flow

---

푸시, 풀리퀘스트, 머지 했으면 항상 로컬메인의 main에도 반영을 해서 같은 버전으로 따라가게 해주고 있다.

(하지만, 아예 다른 버전을 만들어 따로 관리한다면 그럴 필요 없다.)

그래서 나는 로컬 main에도 git pull로 현재 머지된 상태를 댕겨왔다.

그럼 로컬, 리모트의 모든 브랜치가 다 같은 상태!

 

 

Piggy 팀플을 하는 동안 우리 팀원들은 master와 각자 작업하는 브랜치로 나누어서 작업을 했다.

요렇게 코드 관리를 위해 브랜치 종류를 나눠서 관리하는 걸 Git Flow라고 한다.

코드스테이츠는 여러 종류의 깃 플로우 중에서도 Git flow를 단순화한 Coz’ Git flow를 제안한다.

 

 

 

📌 Coz’ Git flow

---

코드스테이츠

주요 브랜치 main, dev 두개 + 작업 브랜치로 이루어져 있다.

 

 

main 브랜치

사용자에게 언제든 제품으로 출시할 수 있는 브랜치

회사에 따라서 master, prod, production등 다양하게 불립니다.

“언제든 배포할 수 있다"의 의미는 회사 별로, 팀 별로 다를 수 있습니다. 다만, 최소한의 기준을 세워볼 수 있습니다.

• 대표적인 기능이 완성되었다.
• 기존 기획했던 레이아웃이나 전체적인 디자인이 얼추 완성되었다.
• 클라이언트, 서버, 데이터베이스가 공개된 웹에서 정상적으로 통신할 수 있다.
• 최소한의 보안이 마련되었다.
  • 브라우저에서 개발 버전에서 사용하던 secret이나 유저의 비밀번호가 노출되는가?
  • 유저의 기밀 정보 조회를 위해 인증 토큰, 세션이 꼭 필요한가?

이렇게 일정 기준을 충족했고, 핵심 기능이 완성되었으면 main 브랜치로 배포를 할 수 있습니다.

 

 

 

dev 브랜치

다음 버전 배포를 위한 "개발 중!" 브랜치

dev 브랜치는 다음 버전 배포를 위한 "개발 중!" 브랜치입니다. main 브랜치에서부터 브랜칭을 하는게 보통이며, 가능하면 프로젝트 팀원과 프론트엔드와 백엔드의 결과를 합쳐서 확인해볼 수 있을 정도로 준비가 되어야 합니다. CI/CD 파이프라인이 잘 구축되어 있다면 dev 브랜치의 코드도 배포를 해두고 수시로 확인할 수도 있습니다.

main 브랜치와 dev 브랜치는 Github 리포지토리에 늘 업데이트 되어있어야 하며, 팀원의 코드 리뷰를 받고 진행하는 것이 정석입니다. 엄밀한 코드 리뷰가 어렵다면, 같이 모여서 코드에 대해서 이야기를 나누고, 배포 상황을 점검하는 스텐드업 회의를 열어도 좋습니다. 너무 격식이 있을 필요는 없지만, 가능하면 모든 팀원이 확인 가능하게 “어떤 코드의 어디를 왜 이렇게 바꿨으면 좋겠다.”라는 코멘트를 Github Pull Request에 남기는 것을 권장합니다.

 

 

 

feature 브랜치

feature 브랜치는 기능 개발, 리펙토링, 문서 작업, 단순 오류 수정 등 다양한 작업을 기록하기 위한 브랜치입니다. 분류를 세세하게 나누기를 원하는 회사에서는 refactor, fix, docs, chore와 같이 세세하게 커밋 메시지나 브랜치 명에 prefix를 달기도 합니다. 아래는 feature 브랜치 이름과 커밋 메시지의 예시입니다. 더 많은 사례는 Conventional Commits 에 대해서 확인하실 수 있습니다.

hash (브랜치 명) 커밋 메시지
2f85eea (feat/create-todo) feat: Todo 추가 기능
2ad0805 (fix/var-name) fix: 변수 네이밍 컨벤션에 맞게 변수명 변경 (ismale => isMale)
e7ce3ad (refactor) refactor: 불필요한 for 루프 삭제

feature 브랜치는 보통 각 개인의 로컬 리포지토리에서 만들고 작업합니다. feature 브랜치는 기능 개발을 위한 브랜치이기 때문에 2명 이상 같이 작업하는 경우가 드물어서, 브랜치 생성이나 삭제에 대해서 너무 두려워 할 필요는 없습니다. 작은 기능이라도 브랜치를 새로 만들고, 자주 커밋하고, 자주 원격 Github 리포지토리에 push하여 팀원들과 결과를 공유하는 것이 바람직합니다. 개인 로컬 리포지토리에서 너무 오래 작업을 하다보면, 쉽게 발견할 수 있는 오류도 발견이 되지 않곤 합니다. 더 나은 코드를 위해 피드백 받는 것을 두려워하지 맙시다.

회사에 따라서 커밋 기록을 남기는 일반적인 rebase-and-merge, 기능마다 깔끔하게 커밋을 남기기를 원해서 커밋 기록을 정리하는 squash-and-merge등 다양한 merge 전략이 있습니다. 이번 Pre-Project에서는 squash-merge 전략을 사용해보고, Main-Project에서는 팀원간 상의를 통해 merge 전략을 세우길 바랍니다. 많은 경우 feature 브랜치는 머지하고 나서 삭제하지만, 복원해야 할 필요성이 있는 경우는 남겨두기도 합니다.

 

오호라

근데 squash-and-merge를 더 자세히 알아보자

 

 

 

squash-and-merge란?

squash-and-merge는 병합할 때 여러개의 커밋을 하나의 커밋으로 합친 후 머지 하는 방식

Squash merging is a merge option that allows you to condense the Git history of topic branches when you complete a pull request. Instead of each commit on the topic branch being added to the history of the default branch, a squash merge adds all the file changes to a single new commit on the default branch

아직 정확히는 모르겠지만, 작업할 걸 마스터/메인에 바로 커밋하는 게 아니라, 로컬에서 각각 작업한 브랜치들을 먼저 머지한 후,

그 다음에 마스터/메인에 병합하는 걸로 이해했다.

 

 

 

 

 

 

 

 

 

참고

코드스테이츠

https://docs.microsoft.com/ko-kr/azure/devops/repos/git/merging-with-squash?view=azure-devops

https://sabarada.tistory.com/196