GDK 개발 환경 설치

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

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

GDK

로컬 가상 머신에서 GDK를 사용하고 싶다면, GDK-in-a-box 구성하기의 단계를 따르세요.

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

GitLab Development Kit (GDK) 설치 및 구성

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

GDK를 설치하는 데 약 두 시간이 소요됩니다. 모든 것이 순조롭게 진행된다면, 설치하는 데 약 한 시간이 걸릴 것입니다.

때때로 설치가 작동하기 위해 약간의 조정이 필요하므로 문제 해결을 위한 시간도 따로 마련해야 합니다.

많은 작업처럼 보일 수 있지만 GDK가 실행되는 단계를 완료하면, 변경 사항을 자유롭게 적용할 수 있게 됩니다.

GitLab in GDK

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. 메시지 Where would you like to install the GDK? [./gitlab-development-kit]에서, 기본 위치를 수락하려면 Enter를 누르세요.
  7. 메시지 Which GitLab repo URL would you like to clone?에서 GitLab 커뮤니티 포크 URL을 입력하세요:

    https://gitlab.com/gitlab-community/gitlab.git
    
  8. 메시지 GitLab would like to collect basic error and usage data에서, 프롬프트에 따라 옵션을 선택하세요.

    설치가 진행되는 동안 표시된 메시지를 복사하세요. 설치 중 발생하는 문제에 대해 이 출력을 문제 해결의 일부로 사용할 수 있습니다.

  9. 설치가 완료된 후, 메시지 INFO: To make sure GDK commands are available in this shell에 해당하는 메시지에서 자신의 셸에 대한 source 명령을 복사하세요:

    source ~/.asdf/asdf.sh
    
  10. GDK가 설치된 디렉토리로 이동하세요:

    cd gitlab-development-kit
    
  11. gdk truncate-legacy-tables를 실행하여 주요 및 CI 데이터베이스의 데이터가 잘려진 상태인지 확인한 후, gdk doctor를 실행하여 GDK 설치를 확인하세요:

    gdk truncate-legacy-tables && gdk doctor
    
    • gdk doctor가 오류를 반환하면 GDK 문제 해결 섹션을 참조하세요.
    • gdk doctorYour 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 stopgdk start를 실행합니다.

오류가 발생하면, gdk doctor를 실행하여 문제를 해결하십시오.

더 고급 문제 해결을 위해 GDK 문제 해결 섹션으로 계속 진행하십시오.

GDK 문제 해결

참고:
더 고급 문제 해결을 위해 다음을 참조하십시오.
문제 해결 문서
Discord의 #contribute 채널.

문제가 발생하면 gitlab-development-kit/gitlab 디렉토리로 가서 gdk doctor를 실행하십시오.

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

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

오류: 명령에 대한 버전이 설정되지 않음

시스템에 다른 버전 관리자를 이미 사용하고 있는 경우, “명령 에 대한 버전이 설정되지 않음” 오류가 발생할 수 있습니다.
이 문제를 해결하려면, 셸에서 asdf.sh의 소스를 임시로 주석 처리할 수 있습니다:

  1. 셸 구성 파일을 엽니다 (예: .zshrc, .bashrc):

    nano <path-to-shell-config>
    
  2. 다음 줄을 주석 처리합니다:

    # Added by GDK bootstrap
    # source ~/.asdf/asdf.sh
    
  3. 이러한 변경을 한 후, 변경 사항을 적용하기 위해 셸 또는 터미널 세션을 다시 시작합니다.

다시 asdf를 사용하려면, 이전 변경 사항을 되돌리십시오.

코드 변경

GDK가 준비되면, GDK로 코드 기여를 계속하십시오.