이 글의 핵심 주제를 한눈에 설명하는 이미지입니다: Git 서브모듈(Submodule)로 프로젝트 의존성 관리하기

Git 서브모듈이란?

Git 서브모듈을 사용하면 Git 저장소를 다른 Git 저장소의 하위 디렉터리로 유지할 수 있습니다. 이는 별도로 개발 및 유지 관리되는 외부 라이브러리나 다른 구성 요소에 대한 의존성을 포함하고 관리하는 좋은 방법입니다.

서브모듈은 특정 커밋에 고정된 별도의 Git 저장소입니다. 종종 “슈퍼프로젝트”라고 불리는 메인 저장소는 해당 커밋에 대한 참조를 저장합니다.

문제 상황

타사 라이브러리를 사용하는 프로젝트에서 작업하고 있습니다. 라이브러리의 소스 코드를 프로젝트에 직접 포함하고 싶지만, 새 버전이 출시될 때 라이브러리를 쉽게 업데이트할 수도 있기를 원합니다.

라이브러리 코드를 저장소에 복사할 수도 있지만, 그렇게 하면 업데이트가 수동적이고 오류가 발생하기 쉬운 프로세스가 됩니다.

해결 방법

1. 서브모듈 추가하기

새 서브모듈을 추가하려면 git submodule add 명령을 사용합니다. 저장소의 URL과 배치할 경로가 필요합니다.

git submodule add https://github.com/example/library.git external/library

이 명령은 두 가지 작업을 수행합니다.

  1. library 저장소를 external/library 디렉터리로 복제합니다.
  2. 루트 디렉터리에 .gitmodules 파일을 생성(또는 업데이트)합니다. 이 파일은 서브모듈 경로를 URL에 매핑합니다.
  3. 새 서브모듈 디렉터리와 .gitmodules 파일을 스테이징합니다.

이제 슈퍼프로젝트에 변경 사항을 커밋합니다.

git commit -m "Add the library submodule"

2. 서브모듈이 있는 프로젝트 복제하기

다른 사람이 프로젝트를 복제하면 서브모듈 디렉터리가 생성되지만 비어 있습니다.

서브모듈의 내용을 초기화하고 복제하려면 다음을 실행해야 합니다.

git submodule init
git submodule update

또는 --recurse-submodules 플래그를 사용하여 슈퍼프로젝트를 복제하여 한 단계로 수행할 수 있습니다.

git clone --recurse-submodules https://github.com/your/project.git

3. 서브모듈 업데이트하기

시간이 지남에 따라 사용 중인 라이브러리가 업데이트됩니다. 최신 변경 사항을 서브모듈로 가져오려면:

  1. 서브모듈 디렉터리로 이동합니다. 
    cd external/library
  2. 최신 변경 사항을 가져오고 원하는 브랜치(예: main)를 체크아웃합니다. 
    git fetch
git checkout main
git pull
  3. 슈퍼프로젝트의 루트 디렉터리로 돌아갑니다. 
    cd ../..
  4. external/library에 새로운 변경 사항이 있음을 알 수 있습니다. 슈퍼프로젝트에서 이 업데이트를 스테이징하고 커밋합니다. 
    git add external/library
git commit -m "Update library to the latest version"

이렇게 하면 슈퍼프로젝트의 포인터가 서브모듈의 새 커밋으로 업데이트됩니다. 다른 협업자는 git submodule update --remote를 실행하여 이 업데이트를 받을 수 있습니다.

서브모듈 제거하기

서브모듈 제거는 여러 단계의 프로세스입니다.

  1. 서브모듈 초기화 해제: git submodule deinit -f external/library
  2. .gitmodules에서 서브모듈 항목 제거 및 인덱스에서 디렉터리 제거: git rm -f external/library
  3. .git 디렉터리에서 서브모듈 디렉터리 제거: rm -rf .git/modules/external/library
  4. 변경 사항을 커밋합니다.

결론

Git 서브모듈은 외부 Git 저장소에 대한 의존성을 관리하는 강력한 방법입니다. 외부 코드를 별도로 유지하면서 프로젝트에 깔끔하게 통합할 수 있습니다. 때때로 작업하기 까다로울 수 있지만, 버전 관리되는 다른 구성 요소에 의존하는 프로젝트에는 매우 유용합니다.

전문 보완 체크

Git 서브모듈(Submodule)로 프로젝트 의존성 관리하기에서 중요한 기준은 독자가 한 번 따라 해서 성공했는지가 아닙니다. 이 주제는 재현 가능한 디버깅 절차로 다루는 편이 안전합니다. 결론을 내리기 전에 저장소 루트, 브랜치와 원격 상태, 인덱스와 작업 트리, 인증 또는 네트워크 경계를 확인해야 합니다. 또한 나중에 같은 문제가 반복될 수 있으므로, 관찰한 사실과 사용한 가정, 결론이 바뀔 조건을 짧은 결정 기록으로 남기는 것이 좋습니다.

신뢰도를 높이는 증거

작업을 바꾸기 전에는 객관적인 증거를 먼저 확인해야 합니다. 쓸 만한 증거에는 git status, git remote -v, git branch --show-current, 실패한 정확한 명령가 포함됩니다. 증거가 서로 맞지 않으면 억지로 하나의 이야기로 합치지 말고 충돌 자체를 남겨야 합니다. 빠른 해결이 한 번 성공했더라도 같은 입력, 계정, 의존성, 기기 상태에서 다시 확인하지 않았다면 아직 확정된 해결책이라고 보기 어렵습니다.

검토 표

검토 항목 확인할 내용 중요한 이유
범위 이 글이 다루는 정확한 사례 조언을 과도하게 적용하지 않게 합니다
기준 상태 변경 전 상태 되돌리기와 비교를 가능하게 합니다
변경 실제로 수행한 가장 작은 조치 숨은 부작용을 줄입니다
결과 변경 뒤 관찰한 출력 또는 반응 기대와 증거를 구분합니다
재확인 결론을 다시 볼 시점 글의 정확도를 유지합니다

예외 상황과 실패 모드

주요 위험은 증상만 고치고 원인을 남기는 상황, 서로 무관한 변경을 같은 테스트에 섞는 상황입니다. 생산 데이터, 개인정보, 돈, 건강, 법적 권리, 보안 복구가 관련되어 있다면 넓은 해결책을 바로 적용하기보다 먼저 증거를 모으는 보수적인 접근이 낫습니다. 같은 제목의 문제라도 환경이 다르면 원인이 달라질 수 있으므로, 독자는 명령이나 결정을 복사하기 전에 자신의 조건이 글의 가정과 맞는지 비교해야 합니다.

유지보수 기준

이 안내는 의존성, 운영체제, 빌드 도구가 바뀐 뒤 다시 확인해야 합니다. 좋은 업데이트는 글 전체를 다시 쓰는 것이 아니라 예시, 링크, 명령, 화면, 판단 기준이 현재 동작과 여전히 맞는지 확인하는 일입니다. 기존 결론이 유효하면 확인 날짜를 남기고, 바뀌었다면 무엇이 바뀌었고 왜 이전 조언만으로 부족한지 설명해야 합니다.

실행 전 질문

  • 문제나 판단이 실제임을 보여 주는 가장 작은 관찰 신호는 무엇인가?
  • 공식 출처는 무엇이고, 내부 판단은 어느 부분인가?
  • 변경 전에 반드시 캡처해야 할 기록은 무엇인가?
  • 어떤 결과가 나오면 이 글의 조언이 맞지 않는다고 볼 것인가?
  • 같은 문제가 반복될 때 누가 이 기록을 다시 봐야 하는가?

적용 검토 시나리오

독자가 Git 서브모듈(Submodule)로 프로젝트 의존성 관리하기의 첫 번째 권장 조치를 이미 시도했지만 결과가 여전히 불확실하다고 가정해 봅니다. 다음 단계는 여러 해결책을 한꺼번에 시험하는 것이 아니라 짧은 감사 기록을 만드는 것입니다. 먼저 어떤 판단을 하려는지 한 문장으로 쓰고, 환경을 한 문장으로 적고, 관찰된 결과를 한 문장으로 남깁니다. 그다음 저장소 루트, 브랜치와 원격 상태, 인덱스와 작업 트리, 인증 또는 네트워크 경계를 이미 확보한 사실과 대조합니다. 이렇게 해야 글이 서로 끊어진 팁 목록이 아니라 검증 가능한 절차가 됩니다.

감사 기록 양식

항목 예시 기준 이유
관찰 조치 전 실제로 본 내용 기준 상태를 객관화합니다
증거 git status, git remote -v 판단을 기록에 연결합니다
가정 믿고 있지만 아직 증명하지 못한 내용 숨은 추정을 드러냅니다
조치 한 번에 하나의 변경 결과의 원인을 추적하게 합니다
중단 기준 멈추고 도움을 요청할 조건 반복적인 시행착오를 줄입니다

품질 경계

같은 결과가 통제된 재확인 뒤에도 반복될 때만 이 안내를 강한 결론으로 보아야 합니다. 계정, 기기, 데이터 샘플, 의존성 버전, 계약 조건, 공식 규칙이 달라졌다면 결론의 강도를 낮추고 가설로 다루는 편이 안전합니다. 검색 독자는 급한 문제를 안고 들어오는 경우가 많아 맥락을 건너뛰기 쉽습니다. 전문적인 글은 위험한 판단을 천천히 하게 만들면서도 다음 행동은 분명하게 제시해야 합니다.

함께 보면 좋은 글

같은 주제 흐름에서 이어서 읽기 좋은 글입니다.

Leave a comment

You may also enjoy