Git) 서브모듈 추가 및 제거

Intro

A 라는 프로젝트 아래에 B 라는 서브 모듈이 필요 하게 되었습니다.

이미 B 프로젝트는 C 프로젝트를 서브 모듈로 가지고 있는 상황이었는데, A 프로젝트에 B 프로젝트를 서브 모듈로 추가하고, 다시 삭제하는 과정을 진행 해 보도록 하겠습니다.

서브모듈 추가

git submodule add 저장소주소 서브모듈경로 로 추가 할 수 있습니다.

아래의 명령어는 메인 git 저장소의 /build 폴더에 url-to-pdf 라는 프로젝트를 url-to-pdf 라는 이름으로 서브모듈로 추가하는 예시 입니다.

git submodule add git@github.com:Shane-Park/url-to-pdf.git build/url-to-pdf

이후 확인해보면 .gitmodules에 [submodule "build/url-to-pdf"] 로 시작하는 서브모듈에 대한 경로 및 주소 데이터가 자동으로 작성 되어 있으며, 지정한 폴더에 해당 서브모듈이 클론 되어 있습니다.

서브 모듈의 상태를 확인 하려면 아래의 명령어를 입력 해 주면 됩니다.

git submodule status

status 명령어 입력시, 서브모듈의 목록이 출력 됩니다.

지금의 구조는 A 프로젝트가 B 프로젝트를 서브 모듈로 가지고 있는 상태인데, B 프로젝트가 가지고 있는 C 프로젝트의 경로가 빈 폴더인 상태입니다. 서브모듈을 업데이트 시켜 줍니다.

git submodule update --init --recursive

서브모듈 제거

이번에는 방금 추가했던 서브 모듈을 그대로 삭제 하도록 하겠습니다.

git rm -f build/url-to-pdf

명령어를 실행 하면 .gitmodules 에서 작성되어 있던 [submodule "build/url-to-pdf"] 로 시작하는 서브모듈에 대한 내용과 해당 경로의 파일들도 함께 삭제가 됩니다.

이후 완벽하게 흔적을 제거 하려면 숨김폴더인 .git/modules/ 하위로 들어가 삭제한 모듈의 폴더를 지워 주시면 (지금의 경우 url-to-pdf 라는 이름) 깔끔하게 모두 제거가 됩니다. 이렇게 하지 않으면 나중에 같은 이름의 모듈을 추가 하려고 할 때에

A git directory for 'build/url-to-pdf' is found locally with remote(s):

If you want to reuse this local git directory instead of cloning again from git@github.com...

use the '--force' option. If the local git directory is not the correct repo
or you are unsure what this means choose another name with the '--name' option.

와 같은 에러가 나며 같은 이름을 사용 할 수 없다고 합니다. 그때는 아직 삭제가 되어 있지 않다면 modules 폴더 하위에서 일치하는 이름의 폴더를 제거 해 주거나 메시지에 나온 것 처럼 --force 옵션을 쓰거나 모듈의 이름을 변경 하면 됩니다.

이상입니다.