GDK 개발 환경 설치

요약

GitLab 코드베이스에 기여하고 변경 사항을 테스트할 수 있는 개발 환경을 원한다면, GitLab Development Kit (GDK)를 사용할 수 있습니다. GDK는 GitLab Self-Managed 설치본, 샘플 프로젝트, 그리고 기능을 테스트할 수 있는 관리자 액세스를 포함하는 로컬 개발 환경입니다.

GitLab 코드베이스에 기여하고 변경 사항을 테스트할 수 있는 개발 환경을 원한다면, GitLab Development Kit (GDK)를 사용할 수 있습니다. GDK는 자유롭게 활용할 수 있는 로컬 버전의 GitLab입니다.

GDK는 GitLab Self-Managed 설치본, 샘플 프로젝트, 그리고 기능을 테스트할 수 있는 관리자 액세스를 포함하는 로컬 개발 환경입니다.

로컬 컨테이너에서 GDK를 사용하려면, GDK-in-a-box 구성 문서의 단계를 따르세요.

이 단계의 인터랙티브 데모 보기.

GitLab Development Kit (GDK) 설치 및 구성#

이미 작동 중인 GDK가 있다면, 커뮤니티 포크를 사용하도록 업데이트하세요.

GDK 설치에 약 두 시간을 할애하세요. 모든 것이 순조롭게 진행되면 약 한 시간 정도 소요됩니다.

경우에 따라 설치가 올바르게 작동하도록 약간의 조정이 필요할 수 있으므로, 문제 해결을 위한 시간도 충분히 확보해 두세요. 많은 작업처럼 보일 수 있지만, GDK가 실행되면 어떤 변경 사항이든 만들 수 있습니다.

GDK를 설치하려면 다음 단계를 따르세요:

지원되는 플랫폼 중 하나를 사용 중인지 확인하세요.
Git이 설치되어 있는지 확인하고, 소스 코드 편집기가 있는지 확인하세요.
GDK를 설치할 디렉터리를 선택하세요. 설치 스크립트는 애플리케이션을 gdk라는 새 하위 디렉터리에 설치합니다.

디렉터리 이름은 짧게 유지하세요. 일부 사용자는 디렉터리 이름이 긴 경우 문제를 겪습니다.
커맨드 라인에서 해당 디렉터리로 이동하세요. 이 예시에서는 dev 디렉터리를 생성하고 이동합니다:
```
mkdir ~/dev && cd ~/dev
```
원라인 설치 명령을 실행하세요:
```
curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash
```
이 스크립트는 GitLab Development Kit (GDK) 리포지터리를 새 하위 디렉터리에 클론하고, mise 버전 관리자를 사용하여 필요한 의존성(Ruby, Node.js, PostgreSQL, Redis 등 포함)을 설정합니다.

해당 의존성에 대해 다른 도구 버전 관리자를 사용하고 있다면, 충돌을 피하기 위해 도구 버전 관리자 문서를 참고하세요.
Where would you like to install the GDK? [./gdk] 메시지가 나타나면, Enter 키를 눌러 기본 위치를 수락하세요.
Which GitLab repo URL would you like to clone? 메시지가 나타나면, GitLab 커뮤니티 포크 URL을 입력하세요:
```
https://gitlab.com/gitlab-community/gitlab-org/gitlab.git
```
GitLab would like to collect basic error and usage data 메시지가 나타나면, 프롬프트에 따라 옵션을 선택하세요.

설치가 진행되는 동안 표시되는 메시지를 복사해 두세요. 설치 중 문제가 발생하면 이 출력을 문제 해결에 활용할 수 있습니다.
설치가 완료된 후 mise를 활성화해야 할 수 있습니다:

bash의 경우:
```
eval "$(mise activate bash)"
```
zsh의 경우:
```
eval "$(mise activate zsh)"
```
GDK가 설치된 디렉터리로 이동하세요:
```
cd gdk
```
gdk truncate-legacy-tables를 실행하여 메인 데이터베이스와 CI 데이터베이스의 데이터가 잘라지도록 한 다음, gdk doctor를 실행하여 GDK 설치를 확인하세요:
```
gdk truncate-legacy-tables && gdk doctor
```
gdk doctor에서 오류가 반환되면, GDK 문제 해결 섹션을 참고하세요.
gdk doctor에서 Your GDK is healthy가 반환되면 다음 단계로 진행하세요.
GDK를 시작하세요:
```
gdk start
```
GitLab available at http://127.0.0.1:3000 메시지가 나타날 때까지 기다린 후, 제공된 URL을 사용하여 GDK에 연결하세요.
사용자 이름 root와 비밀번호 5iveL!fe로 로그인하세요. 처음 로그인 시 비밀번호를 재설정하라는 메시지가 표시됩니다.
GDK로 코드 변경하기로 계속 진행하세요.

기존 GDK 설치 업데이트#

기존 GDK 설치가 있다면, 커뮤니티 포크를 사용하도록 업데이트해야 합니다.

기존 gdk/gitlab 디렉터리를 삭제하세요.

해당 위치에 커뮤니티 포크를 클론하세요:

cd gdk
git clone https://gitlab.com/gitlab-community/gitlab-org/gitlab.git

성공 여부를 확인하려면:

gdk/gitlab 디렉터리가 존재하는지 확인하세요.
최상위 gdk 디렉터리로 이동하여 gdk stop 및 gdk start를 실행하세요.

오류가 발생하면, gdk doctor를 실행하여 문제를 해결하세요. 더 고급 수준의 문제 해결이 필요하다면, GDK 문제 해결 섹션으로 계속 진행하세요.

다른 도구 버전 관리자 사용#

시스템에서 다른 도구 버전 관리자를 사용하고 있다면, 공식적으로 지원되는 도구 버전 관리자는 mise뿐이므로 문제가 발생할 수 있습니다.

asdf를 도구 버전 관리자로 사용하고 있다면, 다음 명령을 사용하여 mise로 마이그레이션할 수 있습니다:

마이그레이션 명령을 실행하세요:
```
gdk rake mise:migrate
```
자세한 내용은 마이그레이션 지침을 참고하세요.

다른 도구 버전 관리자를 계속 사용하려면, GDK를 해당 관리자용으로 구성해야 합니다.

GDK에서 기본 도구 버전 관리자를 사용하지 않도록 설정하세요:
```
gdk config set tool_version_manager.enabled false
```

GDK 문제 해결#

더 고급 수준의 문제 해결을 위해서는 문제 해결 문서와 Discord의 #contribute 채널을 참고하세요.

문제가 발생하면, gdk/gitlab 디렉터리로 이동하여 gdk doctor를 실행하세요.

gdk doctor에서 Node 또는 Ruby 관련 오류가 반환되면 다음을 실행하세요:

yarn install && bundle install
bundle exec rails db:migrate RAILS_ENV=development

코드 변경하기#

GDK가 준비되면, GDK로 코드 기여하기로 계속 진행하세요.