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

VS Code用GitLab Workflow拡張機能

Visual Studio Code用GitLab Workflow拡張機能は、GitLab Duoやその他のGitLabの機能をIDEに直接統合します。GitLab WorkflowパネルがVS Codeのサイドバーに追加されます。このパネルでは、イシュー、マージリクエスト、パイプラインを表示し、カスタムクエリで表示を拡張することができます。

利用を開始するには、拡張機能をインストールして設定します。

設定が完了すると、この拡張機能により、日常的に使用するGitLabの機能がVS Code環境に直接組み込まれます:

さらに、GitLab Workflow拡張機能は、AIアシスト機能によってVS Codeのワークフローを効率化します:

  • GitLab Duo Chat: VS Code内でAIアシスタントと直接やり取りできます。
  • GitLab Duoコード提案: 現在のコード行に対する補完が提案されます。また、自然言語でコードコメントを書くと、より具体的な提案が得られます。

VS CodeでGitLabプロジェクトを表示すると、拡張機能は現在のブランチに関する情報を表示します:

  • ブランチの最新のCI/CDパイプラインのステータス。
  • このブランチのマージリクエストへのリンク。
  • マージリクエストにイシューのクローズパターンが含まれている場合は、そのイシューへのリンク。

VS CodeでGitLabアカウントを切り替える

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

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

拡張機能がステータスバーに表示する内容は、アカウントの設定によって異なります:

複数のGitLabアカウントを持つユーザーのステータスバー（1つは選択済み）。

  • GitLabアカウントが1つしかない場合、ステータスバーには何も表示されません。
  • 複数のGitLabアカウントが存在し、拡張機能が使用するアカウントを特定できる場合、ステータスバーにはタヌキ（ tanuki ）アイコンの横にアカウント名が表示されます。
  • 複数のGitLabアカウントが存在し、拡張機能が使用するアカウントを特定できない場合、ステータスバーにMultiple GitLab Accounts（複数のGitLabアカウント）（ question-o ）と表示されます。

アクティブなVS Codeウィンドウで使用するGitLabアカウントを選択するには、ステータスバーのアイテムを選択するか、次の手順に従います:

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

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 Workflow（ tanuki ）を選択して、拡張機能のサイドバーを表示します。

  2. Issues and Merge Requests（イシューとマージリクエスト）を展開します。

  3. (multiple projects, click to select)（複数プロジェクト、クリックして選択）を含む行を選択します。

  4. ご希望のプロジェクトを選択します:

    プロジェクトとアカウントの組み合わせを選択

Issues and Merge requests（イシューとマージリクエスト）リストが、選択したプロジェクトの情報で更新されます。

選択内容を変更する

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

  1. 垂直メニューバーでGitLab Workflow（ tanuki ）を選択して、拡張機能のサイドバーを表示します。
  2. Issues and Merge Requests（イシューとマージリクエスト）を展開して、プロジェクトリストを表示します。
  3. プロジェクトを選択します。
  4. プロジェクト名の横にあるClear Selected Project close-xs を選択します。

スラッシュコマンドを使用する

イシューとマージリクエストでは、VS Codeでアクションを直接実行できるように、GitLabのスラッシュコマンドがサポートされています。

スニペットを作成する

スニペットを作成して、コードやテキストの一部を保存し、他のユーザーと共有できます。スニペットは、選択範囲またはファイル全体を指定して作成できます。

VS Codeでスニペットを作成するには、次の手順に従います:

  1. スニペットの内容を選択します:
    • Snippet from file（ファイルからスニペット）を作成する場合は、ファイルを開きます。
    • Snippet from selection（選択範囲からスニペット）を作成する場合は、ファイルを開き、含める行を選択します。
  2. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  3. コマンドパレットで、コマンドGitLab: Create Snippetを実行します。
  4. スニペットのプライバシーレベルを選択します:
    • プライベートスニペットは、プロジェクトメンバーのみに表示されます。
    • 公開スニペットは、すべてのユーザーに表示されます。
  5. スニペットのスコープを選択します:
    • Snippet from file（ファイルからスニペット）を作成する場合は、アクティブなファイル全体の内容を使用します。
    • Snippet from selection（選択範囲からスニペット）を作成する場合は、アクティブなファイルで選択した行を使用します。

GitLabは、新しいブラウザタブで新しいスニペットのページを開きます。

パッチファイルを作成する

マージリクエストをレビューするとき、複数のファイルにわたる変更を提案する場合は、スニペットパッチを作成します。

  1. ローカルマシンで、変更を提案するブランチをチェックアウトします。
  2. VS Codeで、変更するすべてのファイルを編集します。変更をコミットしないでください。
  3. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  4. コマンドパレットで、GitLab: Create snippet patchと入力し、候補に表示されたコマンドを選択します。このコマンドはgit diffコマンドを実行し、プロジェクト内にGitLabスニペットを作成します。
  5. Patch name（パッチ名）を入力し、Enterキーを押します。GitLabはこの名前をスニペットのタイトルとして使用し、拡張子.patchが付加されたファイル名に変換します。
  6. スニペットのプライバシーレベルを選択します:
    • プライベートスニペットは、プロジェクトメンバーのみに表示されます。
    • 公開スニペットは、すべてのユーザーに表示されます。

VS Codeは、新しいブラウザタブでスニペットパッチを開きます。スニペットパッチの説明には、パッチを適用する手順が記載されています。

スニペットを挿入する

メンバーになっているプロジェクトから既存の単一ファイルまたは複数ファイルのスニペットを挿入するには、次の手順に従います:

  1. スニペットを挿入する位置にカーソルを置きます。
  2. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  3. GitLab: Insert Snippetと入力し、候補に表示されたコマンドを選択します。
  4. スニペットを含むプロジェクトを選択します。
  5. 適用するスニペットを選択します。
  6. 複数ファイルのスニペットの場合は、適用するファイルを選択します。

イシューとマージリクエストを表示する

特定のプロジェクトのイシューとマージリクエストを表示するには、次の手順に従います:

  1. メニューバーでGitLab Workflow（ tanuki ）を選択して、拡張機能のサイドバーを表示します。
  2. サイドバーでイシューとマージリクエストを展開します。
  3. 目的のプロジェクトを選択して展開します。
  4. 次のいずれかの結果タイプを選択します:
    • 自分にアサインされたイシュー
    • Issues created by me（Issues created by me（自分が作成したイシュー））
    • 自分にアサインされたマージリクエスト
    • Merge requests I’m reviewing（Merge requests I’m reviewing（自分がレビュー中のマージリクエスト））
    • Merge requests created by me（Merge requests created by me（自分が作成したマージリクエスト））
    • All project merge requests（All project merge requests（プロジェクトのすべてのマージリクエスト））
    • Your custom queries（自分のカスタムクエリ）

イシューまたはマージリクエストを選択すると、新しいVS Codeタブで開きます。

イシューを作成

現在のプロジェクトでイシューを作成するには:

  1. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  2. コマンドパレットでGitLab: 現在のプロジェクトで新しいイシューを作成し、Enterキーを押します。

GitLabにより、新規イシューページがデフォルトのブラウザで開きます。

マージリクエストを作成する

現在のプロジェクトでマージリクエストを作成するには、下のステータスバーでCreate MR（MRの作成） ( merge-request-open ) を選択するか、または以下の手順に従ってください:

  1. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  2. コマンドパレットでGitLab: 現在のプロジェクトから新しいマージリクエストを作成し、Enterキーを押します。

GitLabにより、新しいマージリクエストページがデフォルトのブラウザで開きます。

マージリクエストをレビューする

この拡張機能を使用すると、VS Codeを離れることなく、マージリクエストのレビュー、コメント、承認を行えます:

  1. GitLab Workflowサイドバーで、Issues and Merge Requests（イシューとマージリクエスト）を展開し、プロジェクトを選択します。

  2. レビューするマージリクエストを選択します。そのサイドバーのエントリが展開され、詳細情報が表示されます。

  3. マージリクエストの番号とタイトルの下にある説明を選択して、マージリクエストの詳細を確認します。

  4. 提案されたファイルの変更をレビューするには、リストからファイルを選択してVS Codeタブに表示します。GitLabは、差分コメントをタブ内にインライン表示します。リストでは、削除されたファイルは赤色で表示されます:

    このマージリクエストで変更されたファイルと変更タイプのアルファベット順リスト

差分を使用して次の操作を行います:

  • ディスカッションをレビューおよび作成する。
  • ディスカッションを解決および再オープンする。
  • 個々のコメントを削除および編集する。

デフォルトブランチと比較する

マージリクエストを作成せずに、自分のブランチをプロジェクトのデフォルトブランチと比較するには、次の手順に従います:

  1. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  2. コマンドパレットでGitLab: Compare current branch with master（GitLab: 現在のブランチをマスターと比較する）を検索し、Enterキーを押します。

拡張機能が新しいブラウザタブを開き、自分のブランチの最新コミットと、プロジェクトのデフォルトブランチの最新コミットの差分を表示します。

GitLab UIで現在のファイルを開く

現在のGitLabプロジェクトのファイルをGitLab UIで開き、特定の行を強調表示するには、次の手順に従います:

  1. VS Codeで目的のファイルを開きます。
  2. 強調表示する行を選択します。
  3. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  4. コマンドパレットでGitLab: Open active file on GitLab（GitLab: GitLabでアクティブなファイルを開く）を選択し、Enterキーを押します。

セキュリティ検出結果を表示する

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

前提要件:

  • GitLab Workflowバージョン3.74.0以降を使用していること。
  • プロジェクトには、静的アプリケーションセキュリティテスト（SAST）、動的アプリケーションセキュリティテスト（DAST）、コンテナスキャン、または依存関係スキャンなどのセキュリティリスク管理機能が含まれています。
  • セキュリティリスク管理機能が設定されていることを確認してください。

セキュリティ検出結果を表示するには、次の手順に従います:

  1. 垂直メニューバーでGitLab Workflow（ tanuki ）を選択して、拡張機能のサイドバーを表示します。
  2. サイドバーでセキュリティスキャンを展開します。
  3. New findings（新しい検出結果）またはFixed findings（修正された検出結果）のいずれかを選択します。
  4. 表示する重大度レベルを選択します。
  5. 検出結果を選択すると、VS Codeタブで開きます。

SASTスキャンを実行する

  • プラン: Ultimate
  • 提供形態: GitLab.com
  • ステータス: 実験的機能

VS Codeの静的アプリケーションセキュリティテスト（SAST）は、アクティブなファイルの脆弱性を検出します。早期に検出することで、変更をデフォルトブランチにマージする前に脆弱性を修正できます。

SASTスキャンをトリガーすると、アクティブなファイルの内容がGitLabに渡され、SAST脆弱性ルールに照らしてチェックされます。GitLabは、プライマリサイドバーにスキャン結果を表示します。

SASTスキャンのセットアップについては、GitLab UnfilteredのSAST scanning in VS Code（VS CodeでのSASTスキャン）を参照してください。

前提要件:

VS CodeでファイルのSASTスキャンを実行するには、次の手順に従います:

  1. ファイルを開きます。

  2. 次のいずれかの方法でSASTスキャンをトリガーします:

  3. SASTスキャンの結果を表示します。

    1. Primary Side Bar（プライマリサイドバー）を表示します。
    2. GitLab Workflow（ tanuki ）を選択して、拡張機能のサイドバーを表示します。
    3. GITLAB REMOTE SCAN (SAST)（GitLabリモートスキャン（SAST））セクションを展開します。

    SASTスキャンの結果は、重大度の降順で一覧表示されます。検出結果の詳細を表示するには、拡張機能のサイドバーのGITLAB REMOTE SCAN (SAST)（GitLabリモートスキャン（SAST））セクションで検出結果を選択します。

イシューとマージリクエストを検索する

VS Codeからプロジェクトのイシューとマージリクエストを直接検索するには、フィルター検索または高度な検索を使用します。フィルター検索では、定義済みのトークンを使用して検索結果を絞り込みます。高度な検索では、GitLabインスタンス全体をより高速かつ効率的に検索できます。

前提要件:

プロジェクトのタイトルと説明フィールドを検索するには、次の手順に従います:

  1. VS Codeでコマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Command+Shift+Pキーを押します。
  2. 目的の検索タイプ（GitLab: Search project merge requests（GitLab: プロジェクトのマージリクエストを検索）またはGitLab: Search project issues（GitLab: プロジェクトのイシューを検索））を選択します。
  3. テキストを入力し、必要に応じてフィルタートークンを使用します。
  4. 検索テキストを確定するには、Enterキーを押します。キャンセルするには、Escapeキーを押します。

GitLabがブラウザタブで結果を開きます。

トークンで検索をフィルタリングする

大規模なプロジェクトで検索する際は、フィルターを追加するとより適切な結果が得られます。この拡張機能は、マージリクエストとイシューをフィルタリングするための次のトークンをサポートしています:

トークン例説明
assigneeassignee: timzallmann担当者のユーザー名（@なし）。
authorauthor: fatihacet作成者のユーザー名（@なし）。
labellabel: frontendまたはlabel:frontend label: Discussion1つのラベル。複数回使用でき、同じクエリでlabelsと併用できます。
labelslabels: frontend, Discussion, performance複数のラベルのカンマ区切りリスト。同じクエリでlabelと併用できます。
milestonemilestone: 18.1マイルストーンのタイトル（%なし）。
scopescope: created-by-me、scope: assigned-to-me、またはscope: all。指定されたスコープに一致するイシューとマージリクエスト。値: created-by-me（デフォルト）、assigned-to-me、またはall。
titletitle: discussions refactorタイトルまたは説明にこれらの単語を含むイシューとマージリクエスト。フレーズを引用符で囲まないでください。

トークンの構文とガイドライン:

  • 各トークン名の後にはコロン（:）が必要です（例: label:）。
    • コロンの前にスペースを入れる（label :）と無効になり、解析エラーが返されます。
    • トークン名の後のスペースは省略可能です。label: frontendとlabel:frontendはいずれも有効です。
  • labelトークンとlabelsトークンは複数回使用でき、また組み合わせて使用することも​​できます。次のクエリはいずれも同じ結果を返します:
    • labels: frontend discussion label: performance
    • label: frontend label: discussion label: performance
    • labels: frontend discussion performance（最終的に得られる結合クエリ）

1つの検索クエリで複数のトークンを組み合わせることができます。次に例を示します:

title: new merge request widget author: fatihacet assignee: jschatz1 labels: frontend, performance milestone: 17.5

この検索クエリは、次の条件に一致するものを探します:

  • タイトル: new merge request widget
  • 作成者: fatihacet
  • 担当者: jschatz1
  • ラベル: frontendとperformance
  • マイルストーン: 17.5

キーボードショートカットをカスタマイズする

Accept Inline Suggestion（インライン提案を受け入れる）、Accept Next Word Of Inline Suggestion（インライン提案の次の単語を受け入れる）、またはAccept Next Line Of Inline Suggestion（インライン提案の次の行を受け入れる）に対して、別のキーボードショートカットを割り当てることができます:

  1. VS CodeでPreferences: Open Keyboard Shortcutsコマンドを実行します。
  2. 編集するショートカットを見つけて、Change keybinding（キー割り当てを変更）（ pencil ）を選択します。
  3. 使用するショートカットをAccept Inline Suggestionインライン提案を受け入れる）、Accept Next Word Of Inline Suggestion（インライン提案の次の単語を受け入れる）、またはAccept Next Line Of Inline Suggestion（インライン提案の次の行を受け入れる）に割り当てます。
  4. Enterキーを押して変更を保存します。

拡張機能を更新する

拡張機能を最新バージョンに更新するには、次の手順に従います:

  1. Visual Studio Codeで、設定 > Extensions（拡張機能）に移動します。
  2. GitLab (gitlab.com)が発行するGitLab Workflowを検索します。
  3. Extension: GitLab Workflow（拡張機能: GitLab Workflow）で、Update to {later version}（{新しいバージョン}に更新）を選択します。
  4. オプション。今後の自動更新を有効にするには、Auto-Updateを選択します。

ステータスを確認する

  1. Visual Studio Codeの下部ステータスバーで、GitLabアイコン（ tanuki ）を選択します。
  2. VS Codeの検索ボックスの下にメニューが表示され、GitLab Workflow拡張機能のステータスが表示されます。エラーがある場合は**ステータス:**の横に表示されます。

GitLab Duo Chatのステータスも確認できます。

テレメトリを有効にする

GitLab Workflow拡張機能は、Visual Studio Codeのテレメトリ設定を使用して、使用状況とエラー情報をGitLabに送信します。Visual Studio Codeでテレメトリを有効化またはカスタマイズするには、次の手順に従います:

  1. Visual Studio Codeで、Windows/Linuxの場合はファイル > 設定 > 設定に移動します。macOSの場合はコード > 設定 > 設定に移動します。
  2. 検索ボックスで、Telemetryを検索します。
  3. 左側のサイドバーで、Telemetry（テレメトリ）を選択します。
  4. Telemetry Level（テレメトリレベル）で、共有するデータを選択します:
    • all: 使用状況データ、一般的なエラーテレメトリ、クラッシュレポートを送信します。
    • error: 一般的なエラーテレメトリとクラッシュレポートを送信します。
    • crash: OSレベルのクラッシュレポートを送信します。
    • off: Visual Studio Codeのすべてのテレメトリデータを無効にします。
  5. 変更を保存します。