GDK 개발 환경 설치하기

GitLab 코드베이스에 기여하고 변경 사항을 테스트할 개발 환경이 필요하다면 GitLab Development Kit (GDK)을 사용할 수 있습니다. 이는 GitLab의 로컬 버전으로 여러분의 손으로 실험할 수 있는 것입니다.

GDK는 자체 관리형 GitLab, 샘플 프로젝트, 그리고 기능을 테스트할 수 있는 관리자 액세스가 포함된 로컬 개발 환경입니다.

GDK

로컬 가상 머신에서 GDK를 사용하려면 GDK-in-a-box를 구성하는 단계를 따르세요.

이 단계의 대화형 데모 보기.

GitLab Development Kit (GDK) 설치 및 구성

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

GDK 설치에 약 2시간을 예약하십시오. 모든 것이 원활하게 진행되면 설치에 약 1시간이 소요될 것입니다.

가끔 설치에 조정이 필요할 수 있으므로 문제 해결에 시간을 할애해야 합니다. 작업량이 많아 보일 수 있지만, GDK를 실행한 후에는 어떤 변경 사항도 쉽게 할 수 있을 것입니다.

GDK의 GitLab

GDK를 설치하려면:

  1. 지원되는 플랫폼 중 하나를 사용 중인지 확인하세요.
  2. Git이 설치되어 있고 소스 코드 편집기가 있는지 확인하세요.
  3. GDK를 설치할 디렉토리를 선택하세요. 설치 스크립트는 gitlab-development-kit이라는 새 하위 디렉토리에 응용 프로그램을 설치합니다. 디렉토리 이름을 짧게 유지하세요. 일부 사용자는 긴 디렉토리 이름으로 인해 문제가 발생하는 경우가 있습니다.

  4. 명령줄에서 해당 디렉토리로 이동하세요. 예시에서는 dev 디렉토리를 생성하고 변경합니다: 

    mkdir ~/dev && cd "$_"

  5. 한 줄로 된 설치 명령어를 실행하세요: 

    curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash

    이 스크립트는 GitLab Development Kit (GDK) 리포지토리를 새 하위 디렉토리로 클론하고, asdf 버전 관리자(포함된 Ruby, Node.js, PostgreSQL, Redis, 등)를 사용하여 필요한 종속성을 설정합니다.

    note
    해당 종속성에 다른 버전 관리자를 사용하는 경우 충돌을 피하기 위해 문제 해결 섹션을 참조하세요.
  6. 메시지 GDK를 설치하고 싶은 위치는 어디인가요? [./gitlab-development-kit]에 대한 메시지에서 Enter를 눌러 기본 위치를 수락하세요.

  7. 메시지 Clone하고 싶은 GitLab 리포 URL은 무엇인가요?에서 GitLab 커뮤니티 포크 URL을 입력하세요: 

    https://gitlab.com/gitlab-community/gitlab.git

  8. 메시지 GitLab은 기본적인 오류 및 사용 데이터를 수집하고 싶어합니다에서 프롬프트에 따라 옵션을 선택하세요.

    설치 중에 표시된 모든 메시지를 복사하세요. 설치에 문제가 있는 경우 이 출력을 문제 해결의 일부로 사용할 수 있습니다.

  9. 설치가 완료되면 메시지에 나온 셸에 해당하는 source 명령어를 복사하여: 

    source ~/.asdf/asdf.sh

  10. GDK가 설치된 디렉토리로 이동하세요: 

    cd gitlab-development-kit

  11. gdk truncate-legacy-tables를 실행하여 메인 및 CI 데이터베이스의 데이터를 삭제하고, GDK 설치를 확인하기 위해 gdk doctor를 실행하세요: 

    gdk truncate-legacy-tables && gdk doctor
    • 만약 gdk doctor가 오류를 반환하는 경우 GDK 문제 해결 섹션을 참조하세요.
    • 만약 gdk doctor가 Your GDK is healthy를 반환하는 경우 다음 단계로 진행하세요.

  12. GDK를 시작하세요: 

    gdk start
  13. GitLab available at http://127.0.0.1:3000에 대기하고 제공된 URL을 사용하여 GDK에 연결하세요.
  14. 사용자 이름 root와 비밀번호 5iveL!fe로 로그인하세요. 첫 로그인 시 비밀번호를 재설정하라는 프롬프트가 표시됩니다.
  15. GDK로 코드 변경하기로 계속하세요.

기존 GDK 설치 업데이트

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

  1. 기존의 gitlab-development-kit/gitlab 디렉토리를 삭제하세요.

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

    cd gitlab-development-kit
git clone https://gitlab.com/gitlab-community/gitlab.git

성공적으로 완료되었는지 확인하려면:

  1. gitlab-development-kit/gitlab 디렉토리가 있는지 확인하세요.
  2. 최상위 gitlab-development-kit 디렉토리로 이동하여 gdk stop 및 gdk start를 실행하세요.

오류가 발생하면 gdk doctor를 실행하여 문제를 해결하세요. 고급 문제 해결을 위해서는 GDK 문제 해결 섹션을 계속 참조하세요.

GDK 문제 해결

note
고급 문제 해결을 위해서는 문제 해결 문서 와 디스코드의 #contribute 채널을 참조하세요.

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

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

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

오류: No version is set for command

이미 시스템에서 다른 버전 관리자를 사용 중인 경우 “No version is set for command ” 오류가 발생할 수 있습니다. 이 문제를 해결하려면 일시적으로 셸의 asdf.sh 소스를 주석 처리할 수 있습니다.

  1. 셸 구성 파일을 열어주세요 (예: .zshrc, .bashrc): 

    nano <path-to-shell-config>

  2. 다음 라인을 주석 처리하세요: 

    # Added by GDK bootstrap
# source ~/.asdf/asdf.sh

  3. 이러한 변경을 하고 나면 수정 사항이 적용되도록 셸 또는 터미널 세션을 다시 시작하세요.

asdf를 다시 사용하려면 이전 변경 사항을 되돌리세요.

코드 변경

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