머리말
Git 버전 제어 과정에서 다른 독립 Git 저장소의 코드나 파일을 재사용하기 위해 기존 프로젝트에 하위 모듈을 도입해야 하는 경우가 있습니다. 본 글에서는 기존 프로젝트에 Git의 Submodule 서브모듈을 추가, 업데이트, 삭제하는 방법을 자세히 소개하고 관련 샘플 코드를 제공합니다.
실제 전투 시나리오
이미 메인 프로젝트(my-main-project)의 Git 저장소가 있고 프로젝트에 devices라는 폴더를 생성하고 두 개의 하위 모듈 module1과 module2를 도입해야 한다고 가정해 보겠습니다.
1. 서브모듈 추가
먼저 my-main-project 디렉터리에 들어가서 명령줄이나 터미널에서 다음 명령을 실행하여 서브모듈을 추가합니다. 여기서 URL-to-module1및 는 URL-to-module2module1 및 module2의 Git 리포지토리 URL 주소를 나타냅니다.
cd my-main-project
git submodule add <URL-to-module1> devices/module1
git submodule add <URL-to-module2> devices/module2
추가 후 Git은 자동으로 하위 모듈에 대한 독립 디렉터리를 생성하고 원격 저장소의 하위 모듈 코드를 이 디렉터리에 복제합니다.
2. 서브모듈 제출
하위 모듈을 추가한 후 이러한 변경 사항을 기본 프로젝트의 Git 저장소에 커밋해야 합니다. 다음 명령을 실행합니다.
git commit -m "Add submodule: module1 and module2"
그러면 하위 모듈의 수정 사항이 메인 프로젝트의 버전 기록에 커밋 기록으로 추가됩니다.
제출한 후에는 이를 메인 브랜치에 병합하는 것을 잊지 마세요. 그렇지 않으면 다른 프로젝트 개발자가 서브모듈을 업데이트할 수 없습니다. 여기서 LZ는 master제출된 서브모듈이므로 최신 코드를 당겨서 올려주세요.
git pull origin master
git push origin master
3. 하위 모듈 업데이트
다른 개발자는 기본 프로젝트를 복제한 후 하위 모듈을 초기화하고 업데이트하기 위해 몇 가지 추가 단계를 수행해야 합니다. 다음 명령을 사용하여 하위 모듈을 초기화하고 업데이트할 수 있습니다.
git submodule init
git submodule update
그러면 하위 모듈이 초기화되고 로컬로 당겨집니다.
4. 하위 모듈 삭제
어떤 경우에는 더 이상 필요하지 않은 하위 모듈을 제거해야 할 수도 있습니다. 하위 모듈을 삭제하려면 다음 단계를 수행하면 됩니다.
- 메인 프로젝트 파일
.gitmodules에서 해당 서브모듈의 해당 항목을 삭제하고, 서브모듈을 모두 삭제하는 경우.gitmodules파일 전체를 삭제하면 되며, 그렇지 않으면 오류가 발생합니다. - 메인 프로젝트의
.git/config구성 항목에서 서브모듈 관련 항목을 삭제합니다. .git/module/*메인 프로젝트의 삭제 모듈 하위에 있는 하위 모듈 디렉터리를 삭제합니다 . 각 하위 모듈은 디렉터리에 해당하므로 해당 하위 모듈 디렉터리만 삭제하도록 주의하세요.- 하위 모듈의 디렉터리와 해당 내용을 삭제합니다. 위의 예에서는
devices폴더 하위에 삭제할 서브모듈 디렉터리를 삭제하고, 서브모듈을 모두 삭제하면 폴더 전체가 삭제됩니다. - 1~4단계를 수행한 후에도 add submodule 명령 실행 시 여전히 오류가 발생하는 경우, 다음 명령을 실행하여 임시 저장 영역에 있는 메인 프로젝트의 .git 디렉터리에 있는 서브모듈 관련 항목을 삭제하세요.
#删除主项目的.git目录中与子模块相关的条目：git rm --cached 子模块名称
git rm --cached devices/module1
git rm --cached devices/module2
다음 변경 사항을 다시 커밋합니다.
git commit -m "Remove submodule: module1 and module2"
이렇게 하면 메인 프로젝트의 서브모듈을 완전히 삭제할 수 있으며, 제출 후 반드시 메인 브랜치에 병합하는 것을 잊지 마세요.
5. 주의사항
Git의 서브모듈을 사용할 때 다음 사항에 유의하세요.
- 하위 모듈에 대한 수정 사항은 기본 프로젝트에 자동으로 반영되지 않습니다. 하위 모듈의 새 버전을 도입해야 하는 경우 하위 모듈을 수동으로 업데이트해야 합니다.
- 서브모듈 디렉터리에서 직접 수정 및 제출하지 말고, 서브모듈 디렉터리에 들어가서 해당 서브모듈 컨텍스트에서 수정 및 제출해야 합니다.
- 메인 프로젝트를 복제할 때 하위 모듈의 URL이 SSH 프로토콜을 사용하고 해당 SSH 키가 없으면 복제가 실패할 수 있습니다. 이 시점에서 HTTPS 프로토콜 URL을 사용하여 메인 프로젝트를 복제할 수 있습니다.
요약하다
이 기사에서 LZ는 기존 Git 프로젝트에서 하위 모듈을 추가, 제출, 업데이트 및 삭제하는 방법을 설명합니다. 샘플 코드는 기존 프로젝트에 장치 폴더를 추가하고 두 개의 하위 모듈 module1 및 module2를 도입하는 프로세스를 보여주는 데 사용됩니다. 또한 이러한 변경 사항을 기본 프로젝트에 커밋하는 방법과 다른 개발자가 하위 모듈을 초기화하고 업데이트할 수 있는 방법도 설명합니다. 마지막으로 더 이상 필요하지 않은 하위 모듈을 삭제하는 방법을 배웠습니다.