깃허브 SUBMODULE 활용

GitHub Submodule 이란 Git 프로젝트의 폴더에 다른 하위 Git 프로젝트를 포함하는 방식이다.

 

이를 통해서 대규모 프로젝트에서 공통으로 사용되는 라이브러리나 코드베이스를 쉽게 관리할 수 있다.

서브모듈은 별도의 독립적인 Git 저장소로 동작하며, 메인 프로젝트와는 분리된 버전 관리를 제공한다는 장점이 있다.

 

---

처음에 깃 서브 모듈을 프로젝트에 도입하자고 했을때, 왜 필요한가에 대해 의아해 했었다. 그러다 깨달았던 것이 우리 프로젝트는 아래와 같은 방식으로 application.yml파일을 따로 분리해서 운영하고 있다는 것을 알게 되었다. 

application.yml

 

때문에 해당 레포지토리에서 dev, prod버전을 나누어 수정을 해주면 주기적으로 메인 레포지토리에서 가져와 줘야했다.

 

원래는 복사 붙여넣기 방식으로 운영을 할 수 있지만, 보통 application.yml 파일은 git ignore에 집어넣어 커밋할때 빼주기 때문에 git submodule을 활용해주기로 한 것이다. 

 

사용법은 아래와 같다. 

 

# 서브 모듈 초기화하기 / 최초로 가져올 때 한 번만 사용
git submodule update --init --recursive

# 모든 하위 서브모듈까지 업데이트
git submodule update --recursive

# 서브 모듈 업데이트 / 주 서브모듈의 원격 저장소에서 최신 변경사항 가져옴
git submodule update --remote

 

이런 방식으로 application.yml 파일을 관리하니 더 편리했다.