🛠️ Submodule 및 Parent Repository 관리 워크플로우

[eajnoeyeel]

👩‍💻 Submodule 작업 프로세스

1. 작업 브랜치 생성 및 작업 시작

   git checkout -b feature/<your-feature-name>

2. 코드 작업 및 커밋
   작업한 코드를 커밋합니다:

   git add .
   git commit -m "feat: Add <your-feature-description>"

3. Remote main 브랜치로 Merge
   작업이 완료되면 main 브랜치로 이동하여 Merge합니다:

   git checkout main
   git merge feature/<your-feature-name>
   git push origin main

4. Submodule 상태 확인
   변경된 Submodule 상태를 확인하려면:

   git log --oneline

📂 Parent Repository에서 Submodule 관리 프로세스

1. Submodule의 최신 상태 업데이트
   Parent Repository의 develop 브랜치에서 Submodule을 최신 상태로 업데이트합니다:

   git submodule update --remote --merge

   🔍 Note: 이 명령어는 .gitmodules에 설정된 Submodule의 main 브랜치를 기준으로 업데이트합니다.

2. Submodule 변경사항 커밋
   변경된 Submodule을 Parent Repository에 반영합니다:

   git add srcs/<submodule>
   git commit -m "chore: Update <submodule-name> to latest main"
   git push origin develop

3. Parent Repository의 develop → main Merge
   작업이 완료되면 Parent Repository의 main 브랜치로 Merge합니다:

   git checkout main
   git merge develop
   git push origin main

🛠️ 참고 사항 및 주의사항

1. Submodule 상태 확인

   • Submodule이 올바른 커밋을 가리키고 있는지 확인하려면:

     git submodule status

2. Submodule 충돌 발생 시

   • Submodule에서 충돌이 발생하면 해당 디렉토리로 이동하여 직접 해결합니다:

     cd srcs/<submodule>
     git pull origin main

3. Submodule 브랜치

   • 모든 Submodule은 반드시 main 브랜치를 기준으로 작업합니다.
   • .gitmodules에 설정된 브랜치(branch = main)를 확인하세요:

     [submodule "srcs/<submodule>"]
       path = srcs/<submodule>
       url = <submodule-url>
       branch = main

4. 팀원 간 커뮤니케이션

   • Submodule 작업을 Parent Repository로 통합하기 전, 작업 브랜치를 반드시 Submodule의 main으로 Merge하고 Push하세요.

📜 워크플로우 요약

1. 팀원: Submodule 작업 후 main 브랜치로 Merge 및 Push.
2. Parent Repository 관리자:
   • Submodule 최신 상태 업데이트 (git submodule update --remote --merge).
   • Submodule 변경사항 커밋 및 Parent Repository develop → main Merge.

[AhnJoonSung]

머야 “로컬에서 메인으로 머지하고 푸쉬“ 말고
“로컬 작업 브랜치 푸쉬, 피알 생성해서 리뷰하고 메인으로 머지“
이렇게 해도 되는거죠?
로컬에서 메인에 머지하고 푸시하면
코드리뷰가 어려울 것 같은데

[eajnoeyeel]

네네 맞죠 기존 프로젝트 작업 브랜치에서 디벨롭으로 하던 걸 그냥 서브모듈에서는 메인 브랜치에 머지하신다 생각하면 될 것 같아요

[eajnoeyeel]

제가 서브모듈 하자고 해놓고 계속 감 못 잡고 깃이 꼬여가지고... 디벨롭 다 날리고 새로 팠는데 서브모듈들은 독립적인 레포들이라 크게 영향 없는 것 같아요. 혹시 모르니 확인도 한 번 해주세요.

[AhnJoonSung]

서브모듈이 유저나 챗 같은 서비스 레포 말하는거죠?
디벨롭은 디벨롭 브랜치?
기존에도 디벨롭 브랜치 없이 작업 브랜치에서 작업하고 메인으로 피알날려서 머지하는 식으러 하긴 했는데

[AhnJoonSung]

디벨롭 다 날리고 새로 팠다는건 어떤 의민가요
디벨롭 브랜치 말하는게 아닌가?
어떤거 확인하면 될까요
저도 감을 못잡겠네요
같이 잡아보죠

[eajnoeyeel]

네, 맞습니다! 😊

현재 구조

• Parent Repository: 데모 메인 <- 데모 디벨롭
• Submodules: 서브모듈 메인

작업 방법

• 서브모듈 작업자: 기존처럼 각 서브모듈의 main 브랜치에서 작업하시면 됩니다.
• 다만, Parent Repository에서 Submodule을 관리하는 프로세스에 대해 나중에 전체적으로 이해가 필요할 수 있으니 참고 부탁드립니다. 이를 위해 이슈로 정리해서 올렸습니다.

변경 사항 요약

• 제가 어제 Parent Repository의 develop 브랜치를 갈아엎었습니다.
• 이전에는 메인에서 작업하다가 준성님 요청에 따라 디벨롭 브랜치에서 작업하려고 했었는데, 버전이나 작업 내용이 꼬이는 문제가 발생했습니다.
• 그래서 어제 작업했던 내용을 모두 Parent Repository의 main에 적용하고, 거기에서 새로 develop 브랜치를 분기했습니다.

궁금한 점 있으시면 편하게 물어보세요! 🙌

[AhnJoonSung]

아하 완벽히 이해했습니다
인공지능처럼 말씀하시네요

[eajnoeyeel]

ㅋㅋㅋㅋㅋㅋ회사라서 지피티한테 가독성 좋게 편집해달라고 넣고 돌렸어요