[Git] 서브모듈(submodule) 사용법 - 사이드 프로젝트 민감한 정보 숨기기

Git Submodule

사이드 프로젝트를 진행하면서 새롭게 알게된 Git Submodule (서브모듈)을 소개합니다.

 

application.yml

중요한 정보를 같은 백엔드 개발자와만 공유할 수 없을까 ?

Spring 프로젝트에서 application.properties 또는 application.yml 파일에 DB정보나, API Key를 저장합니다. 이러한 민감한 정보가 담긴 파일이 public repository에 올라가지 않기 위해 지금껏 해당 파일을 로컬 PC에 두고 .gitignore 파일에 등록하여 사용했습니다.

 

하지만 해당 정보들이 변경이 되면 다른 백엔드 개발자와 소통하여 맞추지 않으면 다른 환경에서 개발하게 되는 난감한 상황이 생깁니다. 가령 소셜 로그인을 Kakao만 구현했는데, 로그인 MVP가 추가되면서 Google을 추가하기 위해  제 로컬에만 application.yml에 설정을 추가하게 된다면 다른 백엔드 개발자도 직접 코드를 추가해야 합니다. 직접 변경하지 않고 git 서버에 업로드하여 공유하게 된다면 보안이 취약해집니다.

 

따라서 우리는 공통적으로 사용되는 설정이 담긴 application.yml 파일만 가지는 private repository를 생성했습니다. 이를 통해 해당 브랜치의 파일을 서로 공유할 수 있었습니다.

 

변경된 설정들이 자동으로 프로젝트의 반영된다면 ?

하지만 application.yml이 변경이 되었는지는 직접 확인하는 불편함이 있었습니다. 그래서 알게된 것이 바로 Git Submodule입니다! 

 

저장소 안에 다른 Git 저장소를 디렉토리로 분리해 넣는 방식으로 사용되는데, public인 팀 프로젝트의 repository 하위에 공통으로 사용하는 private 프로젝트의 repository를 자식으로 두고 관리할 수 있어 굉장히 편리하게 개발이 가능합니다. 위 그림처럼 다수의 프로젝트가 같은 submodule로 등록한 레포지토리를 접근할 수 있어 클라이언트, 서버 개발자가 동시에 사용할 파일을 별도로 관리할 수 있습니다.

 

아래는 git 공식 Documentation에 기재된 git submodule에 대한 설명입니다.

프로젝트를 수행하다 보면 다른 프로젝트를 함께 사용해야 하는 경우가 종종 있다. 함께 사용할 다른 프로젝트는 외부에서 개발한 라이브러리라던가 내부 여러 프로젝트에서 공통으로 사용할 라이브러리일 수 있다. 이런 상황에서 자주 생기는 이슈는 두 프로젝트를 서로 별개로 다루면서도 그 중 하나를 다른 하나 안에서 사용할 수 있어야 한다는 것이다.

 

git submodule 사용해보기

1. 프로젝트 생성

저희 프로젝트의 submodule로 사용될 프로젝트는 위와 같이 생성했습니다. 개발, 테스트, 운영 서버에서 각각 사용될 yaml파일을 submodule 프로젝트의 별도로 생성해두었습니다. 또한, gitignore처럼 공통적으로 사용되지만 자주 수정될 수 있는 파일들도 만들어주었습니다.

 

yaml 파일을 서버별로 분리해서 관리

 

2. 프로젝트에 Submodule 연결

아래 명령어를 서브모듈을 사용할 프로젝트의 터미널에서 입력해서 서브모듈을 연결합니다.

git submodule add {{서브모듈로 사용할 레포지토리 URL}}

 

명령어를 입력하면 프로젝트 루트 폴더에 생성되는 .gitmodules 파일에 다음과 같이 입력해줍니다. 해당 파일이 추가/수정되었으므로 commit/push를 해주어야 외부에서 사용하려고 할 때 수정된 소스가 존재하지 않아 발생하는 문제가 생기지 않습니다!

[submodule {{서브모듈명}}]
	path = {{프로젝트 폴더 내 경로}}
	url = {{프로젝트 url}}

 

저는 아래처럼 설정해서 config 폴더가 생성되었습니다.

 

정상적으로 서브모듈이 연결되면 git 서버에 push를 했다면 Github에서 프로젝트를 살펴보면 아래처럼 처음보는 폴더가 생깁니다! 저 폴더를 누르면 연결했던 프로젝트로 이동합니다.

 

3. Submodule 업데이트

Intelij를 사용하신다면 Gradle에서 copyGitSubmodule을 실행하여 변경된 버전의 서브모듈을 업데이트할 수 있습니다.

 

터미널을 사용한다면 아래 명령어를 통해 수행할 수 있습니다.

git submodule update

 

만약 여러 서브모듈을 사용한다면 동시에 업데이트도 가능합니다.

git submodule foreach 'git pull'

 

4. Submodule 제거

더 이상 서브모듈을 사용하지 않을 때, 아래 명령어로 연결을 끊을 수 있습니다.

git submodule deinit {{서브모듈명}}
git rm {{서브모듈명}}
git commit-m "chore: 서브모듈 제거"
rm -rf .git/modules/{{서브모듈명}}