[Github] 깃헙 서브모듈: 공통 라이브러리 관리의 필요성과 방법

서브모듈이란?

Submodule 예시

 

서브모듈은 하나의 Git 리포지토리 내에 다른 Git 리포지토리를 포함시키는 기능입니다. 이를 통해 큰 프로젝트를 여러 독립적인 모듈로 나누어 관리하거나, 여러 프로젝트에서 공통된 라이브러리를 재사용할 수 있습니다.

 

개인적으로는 딥러닝 모듈 z를 개발했는데, 이 모듈이 프로젝트 A와 B에 모두 사용되어 어떻게 관리하면 좋을까 고민하다 서브모듈 기능을 사용했어요. 처음에는 그냥 딥러닝 모듈 z를 플젝 A와 B에 복사해둔채로 깃헙에 관리했는데... 이렇게 관리하다보면 A에서 z를 수정하고, B에서도 z를 수정하고... 시간이 지나면 관리 자체가 불가능해 지더라구요 ㅎㅎ. 물론 처음엔 마이너한 수정이라 나중에 다 정리해야지~ 하지만 늘 쉽지 않죠 ㅠㅠ. 그래서! 서브모듈 기능을 사용하면 공통적으로 사용하는 라이브러리를 관리할 때 매우 편리합니다 ~!

 

서브모듈 사용 이유

 

1. 코드 재사용성 향상

• 여러 프로젝트에서 동일한 라이브러리나 모듈을 사용할 때, 해당 모듈을 서브모듈로 포함시켜 코드의 중복 감소
• 이를 통해 유지보수와 업데이트가 편리해짐

 

2. 독립적인 버전 관리

• 서브모듈은 독립적으로 버전 관리가 가능하여, 특정 프로젝트에 맞는 버전을 지정하고 사용할 수 있다
• 이렇게 하면 각 프로젝트가 요구하는 특정 기능을 쉽게 유지할 수 있다.

 

3. 모듈화된 개발

• 프로젝트를 모듈화하여 각 모듈을 독립적으로 개발하고 테스트할 수 있다.
• 이는 개발의 효율성을 높이고, 문제를 격리하여 해결할 수 있게 도와준다.

---

1. 서브모듈을 GitHub에 올리기

서브모듈을 설정하기 위해 먼저 해당 모듈을 독립적인 GitHub 저장소로 생성해야 해요. 이 예제에서는 Goom이라는 서브모듈을 설정할게요.

 

1.1 서브모듈 리포지토리 생성

git clone https://github.com/yourusername/Goom.git
cd Goom

• GitHub에서 새로운 리포지토리를 생성 (Goom이라는 이름으로 리포지토리를 생성)
• 리포지토리를 클론하여 로컬 개발 환경을 설정

 

1.2 서브모듈에 파일 추가

git add .
git commit -m "submodule commit"
git branch -M main
git push -u origin main

• 서브모듈에 필요한 파일을 추가
• 변경 사항을 커밋하고 GitHub에 푸시

 

2. 프로젝트에 서브모듈 추가하기

서브모듈을 설정한 후, 이를 여러 프로젝트에 연동할 수 있어요. 예를 들어, Project_A와 Project_B라는 두 개의 프로젝트가 있다고 가정해 볼게요.

 

2.1 Project_A와 Project_B 구조

Project_A/
├── Goom/ (서브모듈)
│   └── utils.py
└── main.py

Project_B/
├── Goom/ (서브모듈)
│   └── utils.py
└── main.py

• Project_A와 Project_B는 서로 다른 기능을 가진 두 개의 프로젝트로
• 두 프로젝트 모두 공통적으로 Goom 서브모듈을 사용해요

 

2.2 서브모듈 추가 및 설정

Project_A에 서브모듈 추가

mkdir Project_A
cd Project_A
git init
git submodule add https://github.com/yourusername/Goom.git Goom

 

• Goom 폴더가 서브모듈로 추가

 

Project_B에 서브모듈 추가

 

mkdir Project_B
cd Project_B
git init
git submodule add https://github.com/yourusername/Goom.git Goom

• Goom 폴더가 서브모듈로 추가

 

3. 서브모듈 사용 방법

서브모듈을 추가한 후, 프로젝트에서 서브모듈을 활용하여 공통된 기능을 사용할 수 있어요.

 

3.1 서브모듈 초기화 및 업데이트

서브모듈을 클론한 후에는 서브모듈을 초기화하고 업데이트합니다:

# Project_A 또는 Project_B에서 실행
git submodule update --init --recursive

 

3.2 서브모듈의 변경 사항 반영

서브모듈에서 변경 사항이 있을 경우, 다음 단계를 통해 이를 프로젝트에 반영할 수 있어요

 

서브모듈에서 수정 후 푸시

cd Goom
# ~~ 서브모듈의 파일 수정
git .
git commit -m "Add new operation"
git push -u origin main

 

서브모듈 업데이트

cd ..
git submodule update --remote Goom
git add Goom
git commit -m "Update Goom submodule to latest commit"
git push -u origin main

 

---

 

이처럼 GitHub 서브모듈을 사용하면 여러 프로젝트에서 공통된 코드를 효율적으로 관리할 수 있어요. 서브모듈을 독립적으로 관리하면서도, 필요한 프로젝트에 통합하여 코드의 재사용성을 높이고 유지보수를 용이하게 할 수 있지요.