正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

VS Code用のGitLab Workflow extension for VS Codeをインストールして設定する

をインストールするには、次のようにします:

GitLabに接続する

拡張機能をダウンロードしてインストールしたら、GitLabアカウントに接続します。

GitLabに対して認証する

  1. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Control+Shift+Pキーを押します。
  2. GitLab: Authenticateと入力してEnterキーを押します。
  3. オプションからGitLabインスタンスのURLを選択するか、手動で入力します。
    • 手動で入力する場合は、URL to GitLab instance（GitLabインスタンスのURL）に、http://またはhttps://を含む完全なURLを貼り付けます。確認するには、Enterを押します。
  4. 以下を使用してGitLabに対して認証します:

この拡張機能は、GitリポジトリのリモートURLを、トークンに指定したGitLabインスタンスURLと照合します。複数のアカウントまたはプロジェクトがある場合は、使用するアカウントまたはプロジェクトを選択できます。詳細については、VS CodeでGitLabアカウントを切り替えるを参照してください。

リポジトリに接続

VS CodeからGitLabリポジトリに接続するには、次の手順を実行します:

  1. VS Codeの上部メニューで、ターミナル > New Terminal（新しいターミナル）を選択します。

  2. リポジトリをクローンします: git clone <repository>。

  3. リポジトリがクローンされたディレクトリに変更し、ブランチをチェックアウトします: git checkout <branch_name>。

  4. プロジェクトが選択されていることを確認します:

    1. 左側のサイドバーで、GitLab Workflow（GitLab Workflow） ( tanuki )を選択します。
    2. プロジェクト名を選択します。複数のプロジェクトがある場合は、作業するプロジェクトを1つ選択します。

  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（ソース管理） ラベルで右クリックし、リポジトリを選択します。
    3. リポジトリの横にある省略記号( ellipsis_h )を選択し、次にリモート > Add Remote（リモートの追加） を選択します。
    4. Add remote from GitLab（GitLabからリモートを追加）を選択します。
    5. リモートを選択します。

次の両方の場合、拡張機能はVS Codeステータスバーに情報を表示します:

  • プロジェクトに最後のコミットのパイプラインがある。
  • 現在のブランチがマージリクエストに関連付けられている。

拡張機能を設定する

設定を構成するには、設定 > Extensions（拡張機能） > GitLab Workflowに移動します。設定は、ユーザーまたはワークスペースレベルで構成できます。

デフォルトでは、コード提案とGitLab Duoチャットが有効になっているため、GitLab Duoアドオンがあり、シートが割り当てられている場合は、アクセスできるはずです。

認証

personal access tokenを使用するか、OAuthアプリケーションを介してログインして認証します。

パーソナルアクセストークンを作成する

GitLab Self-ManagedまたはGitLab Dedicatedを使用している場合は、personal access tokenを作成してください。

  1. 左側のサイドバーで、自分のアバターを選択します。
  2. プロファイルの編集を選択します。
  3. 左側のサイドバーで、パーソナルアクセストークンを選択します。
  4. 新しいトークンを追加を選択します。
  5. 名前、説明、有効期限を入力します。
  6. apiスコープを選択します。
  7. Create personal access token（パーソナルアクセストークンを作成）を選択します。

OAuthアプリケーションを使用する

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab Self-Managed、GitLab Dedicated

OAuth認証を使用するには、次のいずれかのクライアントIDを知っている必要があります:

  • インスタンスの管理者が管理するインスタンス全体のOAuthアプリケーション。
  • グループオーナーが管理するグループ全体のOAuthアプリケーション。
  • 自身で管理するユーザーOAuthアプリケーション。

OAuthアプリケーションログインを構成するには:

  1. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Control+Shift+Pキーを押します。
  2. Preferences: Open User Settingsと入力してEnterキーを押します。
  3. 設定 > Extensions（拡張機能） > GitLab Workflow > 認証を選択します。
  4. OAuth Client IDs（OAuthクライアントID）で、Add Item（項目の追加）を選択します。
  5. キーを選択し、GitLabインスタンスのURLを入力します。
  6. 値を選択し、OAuthアプリケーションのクライアントIDを入力します。

コードセキュリティ

コードセキュリティ設定を構成するには、設定 > Extensions（拡張機能） > GitLab Workflow > Code Security（コードセキュリティ）に移動します。

  • アクティブなファイルの静的アプリケーションセキュリティテストスキャンを有効にするには、Enable Real-time SAST scan（リアルタイム静的アプリケーションセキュリティテストスキャンを有効にする）チェックボックスを選択します。
  • オプション。保存時にアクティブなファイルの静的アプリケーションセキュリティテストスキャンを有効にするには、Enable scanning on file save（ファイル保存時にスキャンを有効にする）チェックボックスを選択します。

拡張機能のプレリリース版をインストールする

GitLabは、拡張機能のプレリリースビルドをVS Code Extension Marketplaceに公開しています。

プレリリースビルドをインストールするには:

  1. VS Codeを開きます。
  2. Extensions（拡張機能） > GitLab Workflowで、Switch to Pre-release Version（プレリリースバージョンに切り替える）を選択します。
  3. Restart Extensions（拡張機能を再起動）を選択します。
    1. または、Reload Window（ウィンドウを更新）して、更新後に古くなったWebビューを更新します。