Help us learn about your current experience with the documentation. Take the survey.

GitLab 远程 URL 格式

在 VS Code 中，你可以克隆 Git 仓库，或者以只读模式浏览它们。

GitLab 远程 URL 需要以下参数：

  • instanceUrl: GitLab 实例的 URL，不包括 https:// 或 http://。
    • 如果 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>

例如，主 GitLab 项目的 projectID 是 278964，所以主 GitLab 项目的远程 URL 是：

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

克隆 Git 项目

GitLab Workflow 扩展了 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 克隆，选择以 [email protected] 开头的 URL。
    • 使用 HTTPS 克隆，选择以 https:// 开头的 URL。此方法使用你的访问令牌来克隆仓库、获取提交和推送提交。
  7. 选择是打开克隆的仓库，还是将其添加到当前工作区。

以只读模式浏览仓库

使用此扩展，你可以在不克隆的情况下以只读模式浏览 GitLab 仓库。

先决条件：

要以只读模式浏览 GitLab 仓库：

  1. 通过按以下键打开命令面板：
    • MacOS: Command + Shift + P。
    • Windows: Control + Shift + P。
  2. 运行 GitLab: Open Remote Repository 命令。
  3. 选择 在当前窗口打开、在新窗口打开 或 添加到工作区。
  4. 要添加仓库，选择 输入 gitlab-remote URL，然后输入你所需项目的 gitlab-remote:// URL。
  5. 要查看已添加的仓库，选择 选择项目，然后从下拉列表中选择你所需的项目。
  6. 在下拉列表中，选择你想要查看的 Git 分支，然后按 Enter 确认。

要将 gitlab-remote URL 添加到你的工作区文件，请参阅 VS Code 文档中的 工作区文件。