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

GitLabリモートURLの形式

VS Codeでは、Gitリポジトリをクローンしたり、読み取り専用モードで参照したりできます。

GitLabリモートリポジトリのURLには、次のパラメータが必要です:

  • instanceUrl: https://またはhttp://を含まないGitLabインスタンスURL。
    • GitLabインスタンスが相対URLを使用している場合は、URLに相対URLを含めます。
    • たとえば、インスタンスexample.com/gitlab上のプロジェクトtemplates/uiのmainブランチのURLは、gitlab-remote://example.com/gitlab/<label>?project=templates/ui&ref=mainです。
  • label: Visual Studio Codeがこのワークスペースフォルダーの名前として使用するテキスト:
    • これは、インスタンスURLの直後に表示される必要があります。
    • /や?などのエスケープされていないURLコンポーネントを含めることはできません。
    • https://gitlab.comなど、ドメインルートにインストールされたインスタンスの場合、ラベルは最初のパス要素である必要があります。
    • リポジトリのルートを参照するURLの場合、ラベルは最後のパス要素である必要があります。
    • VS Codeは、ラベルの後に表示されるすべてのパス要素を、リポジトリ内のパスとして扱います。たとえば、gitlab-remote://gitlab.com/GitLab/app?project=gitlab-org/gitlab&ref=masterは、GitLab.com上のgitlab-org/gitlabリポジトリのappディレクトリを参照します。
  • projectId: プロジェクトの数値ID（5261717など）またはネームスペース（gitlab-org/gitlab-vscode-extension）のいずれかです。インスタンスがリバースプロキシを使用している場合は、数値IDでprojectIdを指定します。詳細については、issue 18775を参照してください。
  • gitReference: リポジトリのブランチまたはコミットSHA。

パラメータは、次の順序でまとめられます:

gitlab-remote://<instanceUrl>/<label>?project=<projectId>&ref=<gitReference>

たとえば、main GitLabプロジェクトのprojectIDは278964なので、main GitLabプロジェクトのリモートURLは次のようになります:

gitlab-remote://gitlab.com/<label>?project=278964&ref=master

Gitプロジェクトをクローンする

GitLabワークフローは、Git: Cloneコマンドパレットコマンドを拡張します。GitLabプロジェクトの場合、HTTPSまたはGit URLのいずれかを使用したクローンをサポートしています。

前提要件:

  • GitLabインスタンスから検索結果を返すには、そのGitLabインスタンスにアクセストークンを追加する必要があります。
  • 検索結果として返すには、プロジェクトのメンバーである必要があります。

GitLabプロジェクトを検索してからクローンするには:

  1. コマンドパレットを押し開いてください:
    • MacOSの場合: Command+Shift+P。
    • Windows: Control+Shift+P。
  2. Git: Cloneコマンドを実行します。
  3. リポジトリソースとしてGitHubまたはGitLabのいずれかを選択します。
  4. リポジトリ名を検索して選択します。
  5. リポジトリをクローンするローカルフォルダーを選択します。
  6. GitLabリポジトリをクローンする場合は、クローン方法を選択します:
    • Gitでクローンするには、user@hostname.comで始まるURLを選択します。
    • HTTPSでクローンするには、https://で始まるURLを選択します。このメソッドは、アクセストークンを使用してリポジトリのクローンを作成し、コミットをフェッチし、コミットをプッシュします。
  7. クローンされたリポジトリを開くか、現在のワークスペースに追加するかを選択します。

読み取り専用モードでリポジトリを参照する

この拡張機能を使用すると、クローンを作成せずに、読み取り専用モードでGitLabリポジトリを参照できます。

前提要件:

読み取り専用モードでGitLabリポジトリを参照するには:

  1. コマンドパレットを押し開いてください:
    • MacOSの場合: Command+Shift+P。
    • Windows: Control+Shift+P。
  2. GitLab: Open Remoteリポジトリコマンドを実行します。
  3. Open in current window（現在のウィンドウで開く）、Open in new window（新しいウィンドウで開く）、またはAdd to workspace（ワークスペースに追加） を選択します。
  4. リポジトリを追加するには、Enter gitlab-remote URLを選択し、目的のプロジェクトのgitlab-remote:// URLを入力します。
  5. 既に追加したリポジトリを表示するには、プロジェクトを選択するを選択し、ドロップダウンリストから目的のプロジェクトを選択します。
  6. ドロップダウンリストで、表示するGitブランチを選択し、Enterを押して確定します。

ワークスペースファイルにgitlab-remote URLを追加するには、VS Codeドキュメントのワークスペースファイルを参照してください。