GitLab for VS Code拡張機能をインストールしてセットアップする

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がインストールされ、実行されています。
• Visual Studio CodeのDev Containers拡張機能がVS Codeにインストールされています。

VS Code Dev Containerに拡張機能をインストールするには:

1. 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に対して認証する

拡張機能は、あなたの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（ ）を選択します。
   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（ ）を選択します。
   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 environment variablesに保存します。環境変数は、VS Codeストレージを削除しても保持されます。

VS Codeを起動する前に、これらの変数を設定します:

• GITLAB_WORKFLOW_INSTANCE_URL: あなたのGitLabインスタンスURL。例: https://gitlab.com。
• GITLAB_WORKFLOW_TOKEN: あなたのパーソナルアクセストークン。

拡張機能で同じGitLabインスタンスのトークンを設定した場合、拡張機能のトークンが環境変数を上書きします。

アカウントを切り替える

拡張機能は、VS Code workspace（ウィンドウ）ごとに1つのアカウントを使用します。次の場合に自動的にアカウントを選択します:

• 拡張機能で1つのGitLabアカウントのみで認証します。
• VS Codeウィンドウ内のすべてのワークスペースが、git remoteの設定に基づいて同じGitLabアカウントを使用している場合。

複数のGitLabアカウントが存在し、拡張機能が使用するアカウントを判別できない場合、ステータスバーにMultiple GitLab Accounts（ ）を追加します。GitLabアカウントを選択するには、ステータスバーアイテムを選択し、プロンプトに従います。

または、 コマンドパレットを使用できます:

1. コマンドパレットを開きます。
   • macOSの場合は、Command+Shift+Pキーを押します。
   • WindowsまたはLinuxの場合、Control+Shift+Pを押します。
2. コマンドGitLab: Select Account for this Workspaceを実行します。
3. リストからアカウントを選択します。

プロジェクトを選択する

拡張機能は、Gitリポジトリリモートを使用して、どのGitLabプロジェクトをVS Codeワークスペースに関連付けるかを決定します。

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（ ）を選択します。
2. Issues and merge requestsを展開します。
3. （multiple projects, click to select） を含む行を選択します。
4. リストからプロジェクトを選択します。

Issues and merge requestsリストは、選択したプロジェクトの情報で更新されます。

プロジェクトを変更する

プロジェクトの選択を変更するには、次の手順に従います。

1. 左サイドバーでGitLab（ ）を選択します。
2. Issues and merge requestsを展開します。
3. プロジェクトを選択します。
4. プロジェクト名の横にあるClear Selected Project（ ）を選択します。

GitLab Duoを設定する

以下の前提条件を満たす場合、VS CodeでGitLab Duo機能がデフォルトで有効になります:

• エージェント型機能の場合は、GitLab Duo Agent Platformの前提条件を満たしている必要があります。
• GitLab Duoがオンになっている必要があります。
• フローの場合は、基本フローがオンになっている必要があります。
• エージェントの場合は、必要に応じて、基本エージェントがオンになっており、カスタムエージェントが有効になっている必要があります。
• プロジェクトがgroup namespaceにあります。
• default GitLab Duo namespaceが設定されているか、GitLab Duoアクセス権を持つプロジェクトが開いています。
• GitLab Duoコード提案の場合:
  • あなたはsupported language and IDEを使用しています。
  • オプション。オプション。GitLabプロジェクトの外部で使用する場合:
    1. VS Codeで、設定エディタを開きます:
       • macOSでは、Command+,を押します。
       • WindowsまたはLinuxでは、Control+,を押します。
    2. Extensions > GitLab > GitLab Duo > GitLab › Duo: を選択します: Enabled Without GitLab Project。

各セッションで個別にではなく一度にAgentic Chatツールを承認するには、tool approvalsを参照してください。

GitLab Duoをオフにする

VS CodeでGitLab Duo機能をオフにするには:

1. VS Codeで、設定エディタを開きます:
   • macOSでは、Command+,を押します。
   • WindowsまたはLinuxでは、Control+,を押します。
2. Extensions > GitLab > GitLab Duoを選択します。
3. オフにする機能を見つけて、チェックボックスをオフにします。

テレメトリを設定する

GitLab for VS Codeは、VS Codeのテレメトリ設定を使用して、使用状況とエラー情報をGitLabに送信します。VS Codeでテレメトリをオンまたはカスタマイズするには:

1. VS Codeで、設定エディタを開きます:
   • macOSでは、Command+,を押します。
   • WindowsまたはLinuxでは、Control+,を押します。
2. アプリケーション > Telemetryを選択します。
3. Telemetry Level（テレメトリレベル）で、共有するデータを選択します。
   • all: 使用状況データ、一般的なエラーテレメトリ、クラッシュレポートを送信します。
   • error: 一般的なエラーテレメトリとクラッシュレポートを送信します。
   • crash: OSレベルのクラッシュレポートを送信します。
   • off: Visual Studio Codeのすべてのテレメトリデータを無効にします。
4. 変更を保存します。