1. 서브모듈 레포지토리 생성#

먼저 다음과 같이 private 레포를 생성하고 우리가 서브모듈로 관리하고 싶은 정보들을 추가한다. 위 프로젝트에서는 개발 환경 설정, 로컬 환경 설정, 공통 환경 설정 파일들을 위치시켰다.

• application-dev.properties
• application-local.properties
• application.properties

2. 부모 레포지토리에 만든 서브모듈 추가#

이제 앞서 만든 레포지토리를 서브모듈로 추가해야 한다.

서브모듈 추가 명령어

git submodule add {추가할 저장소의 url}

이 때 .gitmodules라는 이름의 숨김 파일이 생성된다. .gitmodules 도 .gitignore 와 마찬가지로 버전관리 대상이다. 이 파일을 통해 프로젝트 참여자들이 이 프로젝트에 어떤 서브 모듈이 있는지 확인할 수 있다.

3. 서브모듈 수정 후 슈퍼 프로젝트에 반영#

서브 모듈을 변경해보고 그 변경 내용을 슈퍼 프로젝트에서 반영해보자.

git add .
git commit -m 'add submodule file'
git push origin main

이 상태는 서브모듈만 업데이트 된 상태이므로 부모는 업데이트가 되지 않은 상태이다. 따라서 부모 레포지토리에 동기화를 해주는 작업을 거쳐야 한다. 일단 서브모듈 디렉토리에서 빠져나와 부모 디렉토리로 이동한다.

git이 알아서 서브모듈을 fetch하고 업데이트하는 명령어

git submodule update --remote

다음 명령어로 부모 레포지토리가 관리하는 서브모듈도 업데이트를 해줄 수 있다.

4. 빌드 시점에 적용하기#

build.gradle

processResources.dependsOn('copySecret')
tasks.register('copySecret', Copy) {
	from './be-submodule' // 서브 모듈 디렉토리 경로
	include "*.properties"  // 설정 파일 복사
	into 'src/main/resources'  // 붙여넣을 위치
}

build.gradle에 다음과 같이 작성하여 프로젝트 빌드/배포할 때 submodules의 설정 파일들을 /src/main/resources으로 복사하여 사용한다.

.gitignore

### application*.properties ###
src/main/resources/*.properties

또한 복사된 설정 파일들이 public 저장소(부모 레포지토리)에 노출되면 안되기 때문에 .gitgnore에 등록해 push하지 않게 한다.

결과#

더 이상 git에 민감한 정보들이 노출되지 않게 되었고 팀원 한 명이 환경 변수를 수정하면 다른 팀원들이 일일이 환경변수를 설정하지 않고 submodule 업데이트만 하여 효율적으로 관리하게 되었다.

ec2에 서브모듈 적용 시 문제 해결#

ec2에서 배포하고 ec2 환경에서 private 파일을 가져오려면 추가적인 자격 검증을 해줘야 한다.

git submodule update --init --recursive

be 폴더에서 다음과 같은 명령어를 작성해서 submodule을 가져와야 하는데 private이라 접근할 수 없다

[ec2-user@ip-172-31-5-208 be]$ git submodule update --remote
Cloning into '/home/ec2-user/be/be-submodule'...
Username for 'https://github.com': maark1106
Password for 'https://maark1106@github.com':

clone하려면 다음과 같이 username과 password를 입력해줘야 하는데 private 파일인 submodule에 접근할 수 있는 자격이 있는지 검증해줘야 한다.

submodule에 접근 권한이 있는 계정에서 생성한 token을 넣어줘야 하는데

settings → developer Settings → Personal access tokens (classic) → generate new token(classic)

• repo (Full control of private repositories 선택)
• read:packages
• write:packages

다음과 같은 설정 후 token을 발급 받는다 다시 git submodule update --init --recursive 명령어 입력 후 github id와 방금 발급 받은 token을 입력하여 private에 접근할 수 있는 자격을 검증하면 된다.

참고 링크#

• https://tecoble.techcourse.co.kr/post/2021-07-31-git-submodule/
• https://hello-judy-world.tistory.com/212