[Git] submodule / subtree

Intro

안녕하세요. 이번 시간에는 git submodule / subtree 에 대해 알아보겠습니다. 

 

submodule

 

# Goal

하나 이상의 외부 저장소 (git 저장소)를 현재 프로젝트에 포함시키기 위해 사용합니다. 

 

# How to work

부모 저장소(repository)는 서브모듈이라 불리는 별도의 저장소를 가리키는 링크만을 유지하고 있습니다. 이 저장소는 자체적으로 독립적인 Git 저장소로서 관리되며, 부모 저장소에는 해당 서브모듈의 상태(커밋 해시)만을 기록합니다.

 

# Usage

서브모듈 추가: git submodule add <repository-url> <path> 

부모 저장소에서 서브모듈 업데이트: git submodule update --init --recursive

 

subtree

# Goal

외부 저장소의 일부 또는 전체를 현재 프로젝트의 서브디렉토리에 통합시키기 위해 사용됩니다.

 

#How to work

외부 저장소의 특정 디렉토리를 현재 저장소로 가져오는 방식으로 동작합니다. 이는 외부 저장소의 특정 커밋 이력을 현재 저장소의 하나의 커밋으로 통합합니다.

 

#Usage

외부 저장소의 특정 디렉토리 가져오기: git subtree add --prefix <prefix> <repository-url> <branch> 

서브트리 업데이트: git subtree pull --prefix <prefix> <repository-url> <branch>

 

Example

 

#git submodule을 사용해야 하는 경우

1. 외부 라이브러리 또는 프로젝트의 특정 버전을 정확하게 포함시키고자 할 때: 예를 들어, 프로젝트가 외부 라이브러리의 특정 버전에 의존하고 있을 때, 해당 버전의 코드를 서브모듈로 추가하여 외부 라이브러리의 업데이트에 영향을 받지 않도록 할 수 있습니다.

# 예시: 외부 라이브러리의 특정 버전을 프로젝트에 포함
git submodule add https://github.com/example/library.git external/library

 

2. 여러 프로젝트에서 공유되는 코드를 유지 및 관리할 때: 여러 프로젝트에서 공통으로 사용되는 코드를 독립적인 저장소로 유지하고, 각 프로젝트에서는 이 코드를 서브모듈로 추가하여 중복을 방지하고 관리의 용이성을 확보할 수 있습니다.

# 예시: 여러 프로젝트에서 공유되는 코드를 서브모듈로 추가
git submodule add https://github.com/example/common-code.git common-code

 

#git subtree를 사용해야 하는 경우

1. 다른 프로젝트의 일부 코드를 현재 프로젝트에 통합할 때: 특정 외부 프로젝트의 특정 디렉토리만을 현재 프로젝트에 통합하고자 할 때, git subtree를 사용할 수 있습니다.

# 예시: 여러 프로젝트에서 공유되는 코드를 서브모듈로 추가
git submodule add https://github.com/example/common-code.git common-code

 

2. 여러 프로젝트 간에 코드를 공유하면서도 각각의 프로젝트에서 코드의 일부분만 사용하고자 할 때: 서브트리를 사용하여 외부 프로젝트의 특정 디렉토리만을 현재 프로젝트로 가져와서 사용할 수 있습니다.

# 예시: 여러 프로젝트 간에 코드를 공유하면서 각각의 프로젝트에서 코드의 일부분만 사용
git subtree add --prefix common-code https://github.com/example/common-code.git main

 

differences between git submodule and git subtree

• Relationship with External Repositories
  • git submodule: 각 서브모듈에 대해 별도이며 독립적인 Git 저장소를 유지합니다. 부모 저장소는 서브모듈의 특정 커밋을 참조합니다.
  • git subtree: 외부 저장소의 내용을 주 저장소의 하위 디렉터리로 가져와, 외부 저장소를 주 저장소에 병합합니다.
• Independence
  • git submodule: 서브모듈은 독립된 저장소입니다. 서브모듈 내의 변경사항은 별도로 추적되며, 부모 저장소에서는 명시적으로 서브모듈의 새로운 커밋으로 업데이트해야 합니다.
    git subtree: 외부 저장소의 코드는 주 저장소의 일부가 되며, 가져온 코드는 주 저장소 내에서 직접 커밋되고 추적됩니다
• Ease of Use
  • git submodule: 서브모듈을 초기화하고 업데이트하기 위해 추가적인 명령(git submodule init, git submodule update)이 필요합니다. 사용자는 서브모듈 특화 명령에 대해 알고 있어야 합니다.
    git subtree: 서브트리는 주 저장소 내의 다른 디렉터리와 마찬가지로 처리됩니다. 사용자는 서브모듈 특화 명령을 걱정하지 않고 익숙한 Git 명령어로 작업할 수 있습니다.
• Workflow
  • git submodule: 프로젝트에 외부 코드를 특정 버전으로 격리되고 버전 관리하고 싶을 때 주로 사용됩니다. 외부 저장소의 특정 버전을 추적하고자 할 때 유용합니다.
    git subtree: 외부 코드를 프로젝트의 디렉터리 구조의 일부로 포함하고, 이를 코드베이스의 중요한 부분으로 취급하려는 경우에 적합합니다.
• Complexity
  • git submodule: 더 정밀한 제어와 격리를 제공하지만, 서브모듈 초기화 및 업데이트 필요로 인해 어느 정도의 복잡성을 추가합니다.
    git subtree: 외부 코드를 프로젝트에 더 단순하게 통합하고자 할 때 사용되며, 서브모듈 특화 명령 없이도 익숙한 Git 명령어로 작업할 수 있습니다.