[공지사항] 푸샤 깃허브 블로그 업데이트 사항

서브모듈(Submodule)이란?

서브모듈이란, 말 그대로 저장소 안에 또 다른 별개의 저장소를 의미하는 서브 저장소(모듈?)이라고 보면 된다. 보통 프로젝트를 진행하다보면 여러 가지 저장소(repository) 운영하기 마련인데, 이때 공통으로 사용하는 코드나 라이브러리를 별도의 저장소 즉, 서브모듈로 두어 관리하면 관리가 용이해진다.

서브모듈 사용방법

  1. 우선 메인 저장소에 git submodule add (서브모듈 Git URL) + (추가하고 싶은 폴더, 예:lib) 명령어로 서브모듈을 추가해준다.
$ git submodule add https://github.com/de24world/submoduleRepoExample.git .libs
Cloning into '.libs/submoduleRepoExample'...
remote: Counting objects: 11, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 11 (delta 0), reused 11 (delta 0)
Unpacking objects: 100% (11/11), done.
Checking connectivity... done.
  1. 그럼 .libs이라는 폴더와 .gitmodules라는 파일이 생성된다. .libs이라는 폴더안에는 https://github.com/de24world/submoduleRepoExample.git의 저장소의 폴더 및 파일들이 불러와져 있고 .gitmodules에는 서브모듈에 대한 정보(경로 및 url)이 나와있다.
.gitmodules
[submodule ".libs"]
    path = libs
    url = https://github.com/de24world/submoduleRepoExample.git
  1. 만약 메인저장소에 .libs의 저장소에서 변경사항이 있고, 이 변경사항을 메인저장소의 submodule(.libs)에 반영하고 싶다면 git submodule update --remote라고 명령어를 입력해주면 .gitmodules에 있는 모든 submodule 원격저장소의 변경사항을 업데이트해준다. (–remote 없이 입력하면 원격저장소의 최신 상태가 아닌 commit한 상태의 버전의 최신상태로 업데이트된다)

서브모듈 명령어

[] 안의 표시는 생략 가능, 중요
git submodule [--quiet] [--cached]
: 현재 서브모듈을 보여준다.

git submodule [--quiet] add [<options>] [--] <repository> [<path>]
: 서브모듈을 추가해준다.

git submodule [--quiet] status [--cached] [--recursive] [--] [<path>…​]
: 서브모듈의 상태를 확인해준다.

git submodule [--quiet] init [--] [<path>…​]
: 서브모듈 정보를 기반으로 로컬 환경설정 파일을 만들어준다. 즉 모든 서브모듈을 가져온다.

git submodule [--quiet] deinit [-f|--force] (--all|[--] <path>…​)
: 서브 모듈 등록을 해제해준다.

git submodule [--quiet] update [<options>] [--] [<path>…​]
: 서브모듈의 리모트 저장소에서 데이터를 가져오고 Checkout한다.

git submodule [--quiet] set-branch [<options>] [--] <path>

git submodule [--quiet] set-url [--] <path> <newurl>

git submodule [--quiet] summary [<options>] [--] [<path>…​]
: 커밋(commit)하지 서브 모듈의 상태를 보여준다.

git submodule [--quiet] foreach [--recursive] <command>
: 서브모듈들이 여러개가 있을 때 여러 서브모듈에서 한 번에 실행할 수 있다.

git submodule [--quiet] sync [--recursive] [--] [<path>…​]

git submodule [--quiet] absorbgitdirs [--] [<path>…​]
  • recursive는 서브모듈의 하위의 모든 내용까지 포함(예 : 서브모듈 안에 또 다른 서브모듈이 있을 수도 있음)

서브트리(Subtree)란?

  • 메인(상위) 프로젝트에 다른 repository 프로젝트를 가져와서 사용할 경우 하나의 repository 로 통합 관리를 할 수 있게 해준다.

  • 메인(상위) 프로젝트에서 하위 repository 까지 한번에 push/pull 을 할 수 있고 하위 repository만 따로 Push/Pull 도 가능하다.

Submodule vs Subtree

Submodule

  • Submodule은 CBD(component-based development)에 적합한 모델이며, 메인 프로젝트는 다른 컴포넌트들에 의존적이다.
  • Submodule은 링크이다.
  • Submoudle은 저장소를 여러개의 작은 저장소로 나눌때 사용한다. 만약 서브 모듈에서 변경을 한다면 서브 모듈 안에서 커밋/푸쉬를 한 후에 메인 저장소(슈퍼 프로젝트)에서 한번 더 커밋/푸쉬를 해야 한다.

Subtree

  • Subtree는 SBD(system-based development)에 더욱 가까우며, 모든 저장소는 모든것을 포함하고 있으며 각 부분을 수정 가능하다.
  • Subtree는 복사다.
  • Subtree를 사용하면 다른 저장소를 하나의 저장소로 이력과 함께 통합할수 있다. 통합을 하게 된다면 저장소의 크기는 커지지만 코드와 이력을 재 사용하기에는 더욱 좋다. 결국 히스토리를 관리하기에 좋다.

요약

  • Subtree는 외부 저장소를 복제하므로 기본 저장소에서 사용할 수 있다.
  • Submodule은 외부 저장소를 복제하고 메인 저장소에서 참조 할 때 링크를 사용한다.
  • 사용자는 Subtree를 사용하여 외부 저장소를 편집 할 수 있다.
  • 외부 저장소가 변경되면 기본 저장소의 Submodule을 직접 업데이트해야한다.
  • 팀 프로젝트에 Subtree가 좀 더 효율적이나 공용 소스 코드의 수정에 기준을 세워야한다.
  • 외부 저장소가 서브 개념으로 작고 업데이트가 적은 저장소라면 Submodule이, 그렇지 않고 외부 저장소가 메인저장소처럼 규모가 크고 변화가 많다면 Subtree가 적당할듯?

참고 영상

참조 문서 및 사이트

상단으로 푸샤 깃허브 이동

댓글남기기

참고