GitLab CI/CD와 함께 Git 서브모듈 사용하기

Tier: Free, Premium, Ultimate

Offering: GitLab.com, Self-managed, GitLab Dedicated

Git 서브모듈을 사용하여 다른 Git 저장소의 하위 디렉토리로 Git 저장소를 유지하세요. 다른 저장소를 프로젝트에 복제하고 커밋을 분리할 수 있습니다.

.gitmodules 파일 구성하기

Git 서브모듈을 사용할 때, 프로젝트에 .gitmodules라는 파일이 있어야 합니다.

GitLab CI/CD 작업에서 작동하도록 구성할 수 있는 여러 옵션이 있습니다.

절대 URL 사용하기

예를 들어, 생성된 .gitmodules 구성은 다음과 같을 수 있습니다:

  • 프로젝트가 https://gitlab.com/secret-group/my-project에 위치합니다.
  • 프로젝트가 포함하려는 https://gitlab.com/group/project에 의존합니다.
  • SSH 주소 git@gitlab.com:secret-group/my-project.git로 소스를 체크아웃합니다.
[submodule "project"]
  path = project
  url = git@gitlab.com:group/project.git

이 경우, GIT_SUBMODULE_FORCE_HTTPS 변수를 사용하여 GitLab Runner에 서브모듈을 복제하기 전에 URL을 HTTPS로 변환하도록 지시하세요.

대신, 로컬에서도 HTTPS를 사용한다면, HTTPS URL을 구성할 수 있습니다:

[submodule "project"]
  path = project
  url = https://gitlab.com/group/project.git

이 경우 추가 변수를 구성할 필요는 없지만, 로컬 복제를 위해 개인 접근 토큰을 사용해야 합니다.

상대 URL 사용하기

경고:

상대 URL을 사용하면 서브모듈이 포크하는 워크플로우에서 잘못 해결될 수 있습니다.

프로젝트에 포크가 예상된다면 절대 URL을 사용하세요.

서브모듈이 동일한 GitLab 서버에 있는 경우, .gitmodules 파일에서 상대 URL을 사용할 수 있습니다:

[submodule "project"]
  path = project
  url = ../../project.git

위 구성을 통해 Git은 소스를 복제할 때 사용할 URL을 자동으로 추론하도록 지시합니다.

모든 CI/CD 작업에서 HTTPS를 사용하여 복제할 수 있으며, 로컬에서 SSH를 계속 사용할 수 있습니다.

동일한 GitLab 서버에 위치하지 않은 서브모듈의 경우, 항상 전체 URL을 사용하세요:

[submodule "project-x"]
  path = project-x
  url = https://gitserver.com/group/project-x.git

CI/CD 작업에서 Git 서브모듈 사용하기

CI/CD 작업에서 서브모듈이 올바르게 작동하도록 하려면:

  1. GIT_SUBMODULE_STRATEGY 변수를 normal 또는 recursive로 설정하여 러너에 작업 전 서브모듈을 가져오도록 지시하세요:

    variables:
  GIT_SUBMODULE_STRATEGY: recursive

  2. 동일한 GitLab 서버에 위치하고 Git 또는 SSH URL로 구성된 서브모듈의 경우, GIT_SUBMODULE_FORCE_HTTPS 변수를 설정하세요.

  3. GIT_SUBMODULE_DEPTH를 사용하여 GIT_DEPTH 변수와 독립적으로 서브모듈의 복제 깊이를 구성하세요:

    variables:
  GIT_SUBMODULE_DEPTH: 1

  4. 특정 서브모듈을 필터링하거나 제외하여 어떤 서브모듈이 동기화되는지 제어하려면 GIT_SUBMODULE_PATHS를 사용하세요.

    variables:
  GIT_SUBMODULE_PATHS: submoduleA submoduleB

  5. GIT_SUBMODULE_UPDATE_FLAGS를 사용하여 고급 체크아웃 동작을 제어하기 위해 추가 플래그를 제공하세요.

    variables:
  GIT_SUBMODULE_STRATEGY: recursive
  GIT_SUBMODULE_UPDATE_FLAGS: --jobs 4

파이프라인 작업에서 서브모듈을 복제하려면 CI_JOB_TOKEN을 사용하는 경우, 작업을 실행하는 사용자는 상위 서브모듈 프로젝트에서 파이프라인을 트리거할 수 있는 권한을 부여받아야 합니다. 또한, 상위 서브모듈 프로젝트에서 CI/CD 작업 토큰 접근이 적절하게 구성되어야 합니다.

문제 해결

.gitmodules 파일을 찾을 수 없음

.gitmodules 파일은 일반적으로 숨겨진 파일이기 때문에 찾기 어려울 수 있습니다.

특정 운영 체제에 대한 설명서를 확인하여 숨겨진 파일을 찾고 표시하는 방법을 알아보세요.

.gitmodules 파일이 없는 경우, 서브모듈 설정이 git config 파일에 있을 가능성이 있습니다.

fatal: run_command returned non-zero status 오류

이 오류는 작업 중에 서브모듈과 함께 작업할 때 발생할 수 있으며, GIT_STRATEGY가 fetch로 설정되어 있습니다.

GIT_STRATEGY를 clone으로 설정하면 문제가 해결됩니다.