[Git] Git Submodule(서브모듈) 이란?

• 이 글은 공식문서를 참고하여 작성한 글입니다.

Submodule

• Git의 서브모듈은 Git 저장소에 다른 사람의 Git 저장소를 하나의 디렉토리에 clone하는 것이 서브모듈입니다.

• 서브모듈에 포함된 데이터는 내 Git 저장소에 디렉토리를 생성하여 넣기 때문에 독립적으로 커밋을 관리할 수 있습니다.

Submodule 사용하기

JNI 실습 코드를 내 원격 저장소(Github)에 올렸습니다.
이 원격 저장소에 새로운 Git 저장소를 서브모듈을 사용하여 디렉토리에 넣도록 하겠습니다.

먼저 서브모듈을 추가하는 명령으로 git submodule add <저장소 URL> 입니다.

명령어를 입력한 결과 .gitmodules와 서브모듈인 Design-Pattern-to-Java 가 추가된 것을 볼 수 있습니다.
이 .gitmodules 파일은 서브 디렉토리명과 서브모듈의 URL의 매핑 정보를 담은 설정파일입니다.

서브모듈 갯수만큼 이 항목이 생기고, .gitignore 파일처럼 버전을 관리합니다.

git status를 확인해본 결과 방금 언급했던 두 가지의 파일들이 스테이징 사태가 된 것을 확인하였습니다.
자세한 변경사항을 알아보기 위해서 git diff --staged 서브모듈명 명령어를 입력하였습니다.

내용에서도 나왔듯이 Git은 Design-Pattern-to-Java 디렉토리 자체를 서브모듈로 취급하여서 모듈 내의 변경사항을 추적하지 않습니다.
즉, 서브모듈 자체를 특별한 커밋으로 취급합니다.

이후 서브모듈을 커밋한 결과입니다.

Design-Pattern-to-Java 서브모듈이 커밋된 것을 확인할 수 있습니다.

Submodule 포함된 프로젝트 Clone

먼저 원격저장소에 있는 소스코드를 clone 합니다.

정상적으로 소스코드를 받아서 .gitmodules와 Design-Pattern-to-Java 폴더가 생긴 것을 확인할 수 있었습니다.

하지만 서브모듈 디렉터리에 가서 파일들을 확인해보면 빈 디렉토리입니다.

서브모듈이 완전히 Clone 과정을 끝내기 위해서는 두 명령어를 실행해야 합니다.
git submodule init : 서브모듈 정보를 기반으로 로컬 환경설정 파일 준비, 초기화
git submodule update : 서브모듈의 원격 저장소에 데이터를 가져옵니다.

서브모듈에 정상적으로 소스코드가 받아지는 것을 확인할 수 있었습니다.
git clone --recurse-submodules <저장소 URL> : 서브모듈이 포함된 프로젝트를 clone할 때 옵션을 추가하면 서브모듈까지 한꺼번에 받을 수 있습니다.