[GitHub] submodule 사용해서 yml과 같은 민감한 정보 숨기기

서론

보통 프로젝트를 진행하다 보면 GitHub 상에서 보여주고 싶지 않은 민감한 정보들이 있습니다. Spring Boot로 프로젝트를 진행할 때 DB의 계정 등을 담을 .yml파일들을 예로 들 수 있습니다.
프로젝트 자체를 private로 설정해서 노출을 방지하는 방법도 있겠지만 submodule을 사용하면 특정 폴더만 private로 설정해서 노출을 막을 수 있습니다.
따라서 이번 게시글에서는 git submodule에 대해서 알아보고, Spring Boot 환경에서 yml파일들을 숨겨보는 방법을 정리해 보겠습니다.

구체적인 과정

1. public repository 생성

public respository

먼저 위와 같이 public repository를 만듭니다. 저는 기초적인 spring boot 프로젝트를 하나 생성했습니다.

기존의 yml 파일 경로

기존에는 위와 같이 submodule-test/src/main/resources 경로에 application.yml 파일이 존재합니다. 우리의 목적은 이 민감한 정보가 담긴 yml 파일들을 public repository에서 숨기더라도 프로젝트는 정상적으로 수행되게 만드는 것입니다. 따라서 public repository의 application.yml파일은 삭제해 줍니다.

public repository의 yml 삭제

2. 민감한 정보를 담을 private repository 생성

private repository

다음으로 yml 파일들을 담을 private repository를 생성합니다.

private repository에 yml 추가

그 후 프로젝트의 민감한 정보가 담길 application.yml 파일을 priavate respotitory에 생성하여 추가합니다.
간단하게 그냥 public repository에 존재하는 민감한 정보를 private repository로 옮기고, clone시에만 연동해서 가져온다고 생각하면 됩니다.

3. public repository에 submodule 등록

git submodule add ${서브 모듈로 등록할 github repository의 주소}

main 프로젝트에 submodule 등록

위와 같이 메인 프로젝트에 submodule을 등록해줍니다.

프로젝트 최상위 경로에 submodule이 생성됨

그러면 위와 같이 프로젝트의 최상위 경로에 submodule의 repository name을 가진 폴더가 생성됩니다.

4. .gitmodules 확인

위 과정까지 거쳤다면 프로젝트의 최상위 폴더에 .gitmodules 파일이 생성될 것입니다.

.gitmodules 파일이 위와 같이 생성되었다.

이제 메인 프로젝트를 github로 push 하면 아래와 같이 main 프로젝트(public repository)에 submodule(private repository)가 생성됩니다.

main 프로젝트에 private repository인 submodule가 생성되었다.

public repository 이더라도 위 submodule 폴더는 private respository 권한이 없는 유저는 접근할 수 없습니다.

5. 만약 submodule의 파일이 수정되었다면?

만약 submodule의 파일이 수정되었다면 git submodule update --remote 명령어를 통해서 submodule의 최신 내용을 메인 프로젝트에 갱신할 수 있습니다.
또한 main project를 새로 clone 하였을 경우에도 위 명령어를 통해서 submodule을 받아 올 수 있습니다.

6. gradle을 submodules의 내용을 빌드 시 가져오기

이제 submodule폴더에 있는 yml 파일들을 빌드 시에 submodule-test/src/main/resources 경로로 가져오게 하는 작업이 필요합니다.
build.gradle에 아래의 코드를 추가합니다.

task copyPrivate(type: Copy) {
	copy {
		from './submodule-data'
		include "*.yml"
		into 'src/main/resources'
	}
}

from은 submodule의 폴더를 지칭하고, include는 포함할 파일, 그리고 into는 빌드 시에 넣을 경로를 지칭합니다.

결과

간단하게 위와 같이 TestEntity를 만들었고, 실행했을 때 무사히 테이블이 생성되는 걸 확인할 수 있습니다.