GitLab for VS Code 확장을 사용하려면 확장을 설치하고 GitLab에 연결한 다음, 필요에 따라 설정합니다.

확장 설치#

필요에 맞는 설치 방법을 선택합니다.

• 표준 VS Code는 Visual Studio Marketplace에서 설치합니다.
• 비공식 VS Code 버전은 Open VSX Registry에서 설치합니다.
• 안전한 로컬 개발 환경을 위해서는 Visual Studio Code Dev Container에 설치합니다.

Visual Studio Code Dev Container에 설치#

보안을 강화하려면 VS Code Dev Containers를 사용하는 컨테이너 개발 환경에서 확장을 설정하고 GitLab Duo를 사용합니다.

사전 요구 사항:

• Docker가 설치되어 실행 중이어야 합니다.
• VS Code에 Visual Studio Code Dev Containers 확장이 설치되어 있어야 합니다.

VS Code Dev Container에 확장을 설치하려면 다음과 같이 진행합니다.

1. Command Palette에서 Dev Containers: Add Dev Container Configuration Files 명령을 실행합니다.

2. 설정 파일에 GitLab 확장을 추가합니다.

   // .devcontainer/devcontainer.json
   {
   "name": "My Project",
   "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
   "customizations": {
      "vscode": {
         "extensions": [
         "GitLab.gitlab-workflow"
         ]
      }
   }
   }
   

3. Dev Containers: Open Folder in Container 명령을 실행해 VS Code Dev Container에서 프로젝트를 엽니다. VS Code가 컨테이너 안에 확장을 자동으로 설치합니다.

GitLab에 연결#

확장을 설치한 다음에는 본인 인증을 하고 프로젝트를 GitLab의 리포지터리에 연결합니다.

GitLab으로 본인 인증#

히스토리

• GitLab 18.3 릴리스 기간 중 GitLab for VS Code 6.47.0에서 GitLab Self-Managed 및 GitLab Dedicated

확장은 Git 리포지터리의 원격 URL을 토큰에 지정한 GitLab 인스턴스 URL과 매칭합니다. 계정이나 프로젝트가 여러 개면 사용할 것을 선택할 수 있습니다.

리포지터리에 연결#

VS Code에서 GitLab 리포지터리에 연결하려면 다음과 같이 진행합니다.

1. VS Code 상단 메뉴에서 Terminal > New Terminal을 선택합니다.

2. 리포지터리를 클론합니다: git clone <repository>.

3. 리포지터리가 클론된 디렉터리로 이동해 브랜치를 체크아웃합니다: git checkout <branch_name>.

4. 프로젝트가 선택되어 있는지 확인합니다.

   1. 왼쪽 사이드바에서 GitLab ([tanuki])을 선택합니다.
   2. 프로젝트 이름을 선택합니다. 프로젝트가 여러 개면 작업할 프로젝트를 선택합니다.

5. 터미널에서 리포지터리에 원격이 설정되어 있는지 확인합니다: git remote -v. 결과는 다음과 비슷하게 표시됩니다.

   origin  git@gitlab.com:gitlab-org/gitlab.git (fetch)
   origin  git@gitlab.com:gitlab-org/gitlab.git (push)
   

   원격이 정의되어 있지 않거나 원격이 여러 개인 경우:

   1. 왼쪽 사이드바에서 Source Control ([branch])을 선택합니다.
   2. Source Control 레이블을 마우스 오른쪽 버튼으로 클릭하고 Repositories를 선택합니다.
   3. 리포지터리 옆의 줄임표()를 선택한 다음 Remote > Add Remote를 선택합니다.
   4. Add remote from GitLab을 선택합니다.
   5. 원격을 선택합니다.

확장은 다음 두 조건을 모두 충족하면 VS Code 상태 표시줄에 정보를 표시합니다.

• 프로젝트에 마지막 커밋에 대한 파이프라인이 있는 경우
• 현재 브랜치가 머지 리퀘스트와 연결되어 있는 경우

확장 설정#

설정을 변경하려면 Settings > Extensions > GitLab으로 이동합니다.

계정 및 프로젝트 설정#

본인 인증 후 리포지터리에 연결하면, 확장이 Git 리포지터리 설정을 기반으로 GitLab 계정과 프로젝트를 자동으로 연결합니다.

일부 환경에서는 자격 증명을 유지하려면 추가 설정이 필요할 수 있습니다.

환경 변수에 토큰 저장#

Gitpod 컨테이너처럼 VS Code 저장소를 자주 삭제하는 환경이라면, 인증 토큰을 VS Code 환경 변수에 저장합니다. 환경 변수는 VS Code 저장소를 삭제해도 유지됩니다.

VS Code를 시작하기 전에 다음 변수를 설정합니다.

• GITLAB_WORKFLOW_INSTANCE_URL: GitLab 인스턴스 URL 입니다. 예를 들면 https://gitlab.com 입니다.
• GITLAB_WORKFLOW_TOKEN: 개인 액세스 토큰입니다.

확장에서 동일한 GitLab 인스턴스에 대한 토큰을 설정하면, 확장의 토큰이 환경 변수보다 우선합니다.

계정 전환#

확장은 VS Code 워크스페이스(창)마다 계정을 하나씩 사용합니다. 다음 경우에는 계정을 자동으로 선택합니다.

• 확장에서 GitLab 계정 하나로만 인증한 경우
• VS Code 창의 모든 워크스페이스가 git remote 설정을 기준으로 동일한 GitLab 계정을 사용하는 경우

GitLab 계정이 여러 개 있어 확장이 사용할 계정을 판단할 수 없으면, 상태 표시줄에 Multiple GitLab Accounts ([question-o])가 추가됩니다. GitLab 계정을 선택하려면 상태 표시줄 항목을 선택하고 안내를 따릅니다.

또는 Command Palette를 사용할 수 있습니다.

1. VS Code에서 View > Command Palette를 선택합니다.
2. GitLab: Select Account for this Workspace 명령을 실행합니다.
3. 목록에서 계정을 선택합니다.

프로젝트 선택#

확장은 Git 리포지터리의 원격을 기준으로 VS Code 워크스페이스에 연결할 GitLab 프로젝트를 판단합니다.

Git 리포지터리에 서로 다른 GitLab 프로젝트를 가리키는 원격이 여러 개 있으면, 확장이 사용할 원격을 판단할 수 없습니다. 예를 들면 다음과 같습니다.

• origin: git@gitlab.com:gitlab-org/gitlab-vscode-extension.git
• personal-fork: git@gitlab.com:myusername/gitlab-vscode-extension.git

이런 경우 확장은 상태 표시줄에 (multiple projects) 레이블을 추가합니다.

프로젝트를 선택하려면 다음과 같이 진행합니다.

1. 왼쪽 사이드바에서 GitLab ([tanuki])을 선택합니다.
2. Issues and merge requests를 펼칩니다.
3. **(multiple projects, click to select)**가 포함된 줄을 선택합니다.
4. 목록에서 프로젝트를 선택합니다.

Issues and merge requests 목록이 선택한 프로젝트의 정보로 업데이트됩니다.

프로젝트 변경#

선택한 프로젝트를 변경하려면 다음과 같이 진행합니다.

1. 왼쪽 사이드바에서 GitLab ([tanuki])을 선택합니다.
2. Issues and merge requests를 펼칩니다.
3. 프로젝트를 선택합니다.
4. 프로젝트 이름 옆의 Clear Selected Project ([close-xs])를 선택합니다.

GitLab Duo 설정#

사전 요구 사항을 충족하면 VS Code에서 GitLab Duo 기능이 기본적으로 활성화됩니다.

• 에이전틱 기능은 GitLab Duo Agent Platform의 사전 요구 사항을 충족해야 합니다.
• GitLab Duo가 켜져 있어야 합니다.
• 플로를 사용하려면 기초 플로가 켜져 있어야 합니다.
• 에이전트를 사용하려면 기초 에이전트가 켜져 있어야 하며, 필요에 따라 커스텀 에이전트가 활성화되어 있어야 합니다.
• Code Suggestions의 경우 추가 사전 요구 사항을 충족해야 합니다.
• 프로젝트가 그룹 네임스페이스에 속해 있어야 합니다.
• 기본 GitLab Duo 네임스페이스가 설정되어 있거나, GitLab Duo 액세스 권한이 있는 프로젝트가 열려 있어야 합니다.

Agentic Chat 도구를 개별적으로가 아니라 세션당 한 번씩 승인하려면 도구 승인을 참고합니다.

Code Suggestions 켜기 또는 끄기#

앞의 사전 요구 사항을 충족하면 Code Suggestions는 기본적으로 켜져 있습니다.

VS Code에서 Code Suggestions를 켜거나 끄려면 다음과 같이 진행합니다.

1. VS Code에서 Settings 편집기를 엽니다.
   • macOS는 Command+,를 누릅니다.
   • Windows 또는 Linux는 Control+,를 누릅니다.
2. Extensions > GitLab > GitLab Duo를 선택합니다.
3. GitLab › Duo Code Suggestions: Enabled에서 체크박스를 선택하거나 해제합니다.
4. 선택 사항. 특정 언어에 대해 Code Suggestions를 끄려면 Code Suggestions 언어 관리를 참고합니다.

또는 VS Code settings.json 파일에서 gitlab.duoCodeSuggestions.enabled를 설정할 수 있습니다.

GitLab 프로젝트 밖에서 Code Suggestions를 사용하려면 다음과 같이 진행합니다.

1. VS Code에서 Settings 편집기를 엽니다.
   • macOS는 Command+,를 누릅니다.
   • Windows 또는 Linux는 Control+,를 누릅니다.
2. Extensions > GitLab > GitLab Duo > GitLab › Duo: Enabled Without GitLab Project를 선택합니다.

GitLab Duo 끄기#

VS Code에서 GitLab Duo 기능을 끄려면 다음과 같이 진행합니다.

1. VS Code에서 Settings 편집기를 엽니다.
   • macOS는 Code > Preferences > Settings를 선택합니다.
   • Windows 또는 Linux는 File > Preferences > Settings를 선택합니다.
2. Extensions > GitLab > GitLab Duo를 선택합니다.
3. 끄려는 기능을 찾아 체크박스를 해제합니다.

원격 측정 설정#

GitLab for VS Code는 Visual Studio Code의 원격 측정 설정을 사용해 사용 정보와 오류 정보를 GitLab에 전송합니다. Visual Studio Code에서 원격 측정을 켜거나 사용자 지정하려면 다음과 같이 진행합니다.

1. VS Code에서 Settings 편집기를 엽니다.
   • macOS는 Code > Preferences > Settings를 선택합니다.
   • Windows 또는 Linux는 File > Preferences > Settings를 선택합니다.
2. Application > Telemetry를 선택합니다.
3. Telemetry Level에서 공유할 데이터를 선택합니다.
   • all: 사용 데이터, 일반 오류 원격 측정, 충돌 보고서를 전송합니다.
   • error: 일반 오류 원격 측정과 충돌 보고서를 전송합니다.
   • crash: OS 수준 충돌 보고서를 전송합니다.
   • off: Visual Studio Code의 모든 원격 측정 데이터를 비활성화합니다.
4. 변경 사항을 저장합니다.