在 VS Code 中使用 GitHub

GitHub 是一个用于存储和共享源代码的云服务。在 Visual Studio Code 中使用 GitHub 可以让你直接在编辑器内共享源代码并与他人协作。与 GitHub 交互的方式有很多种，例如通过他们的网站 https://github.com 或 Git 命令行界面 (CLI)，但在 VS Code 中，丰富的 GitHub 集成是由 GitHub Pull Requests and Issues 扩展提供的。

安装 GitHub Pull Requests and Issues 扩展

要在 VS Code 中开始使用 GitHub，你需要安装 Git，创建 GitHub 账户 并安装 GitHub Pull Requests and Issues 扩展。在本主题中，我们将演示如何在不离开 VS Code 的情况下使用 GitHub 的一些常用功能。

如果你是源代码管理新手，或者想了解更多关于 VS Code 基本 Git 支持的信息，可以从源代码管理主题开始。

开始使用 GitHub Pull Requests 和 Issues

安装 GitHub Pull Requests and Issues 扩展后，你需要登录。按照提示在浏览器中通过 GitHub 验证并返回 VS Code。

如果你没有被重定向到 VS Code，你可以手动添加授权令牌。在浏览器窗口中，你会收到授权令牌。复制令牌，然后切换回 VS Code。在状态栏中选择登录到 github.com...，粘贴令牌，然后按 Enter。

设置仓库

克隆仓库

你可以使用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的 Git: Clone 命令，或者使用源代码管理视图中的克隆仓库按钮（在你没有打开任何文件夹时可用）来搜索和克隆 GitHub 仓库。

从 GitHub 仓库下拉菜单中，你可以筛选并选择要本地克隆的仓库。

使用现有仓库进行身份验证

通过 GitHub 启用身份验证会在你在 VS Code 中运行任何需要 GitHub 身份验证的 Git 操作时发生，例如推送到你所属的仓库或克隆私有仓库。你不需要安装任何特殊扩展进行身份验证；它内置于 VS Code 中，以便你可以高效地管理你的仓库。

当你执行需要 GitHub 身份验证的操作时，会看到登录提示

按照步骤登录 GitHub 并返回 VS Code。使用个人访问令牌 (PAT) 登录仅支持 GitHub Enterprise Server。如果你正在使用 GitHub Enterprise Server 并想使用 PAT，那么你可以在登录提示上点击“取消”，直到系统提示你输入 PAT。

请注意，有多种方法可以对 GitHub 进行身份验证，包括使用用户名和密码配合双因素身份验证 (2FA)、个人访问令牌或 SSH 密钥。有关每个选项的更多信息和详细信息，请参阅关于 GitHub 身份验证。

注意：如果你想在不将内容克隆到本地计算机的情况下处理仓库，可以安装 GitHub Repositories 扩展，直接在 GitHub 上浏览和编辑。你可以在下面的GitHub Repositories 扩展部分了解更多信息。

编辑器集成

悬停

当你打开一个仓库并提到某个用户时（使用 @ 符号），你可以将鼠标悬停在该用户名上，并看到 GitHub 风格的悬停提示。

对于 # 符号提及的问题编号、完整的 GitHub 问题 URL 以及仓库指定的问题，也有类似的悬停提示。

建议

用户建议由“@”字符触发，问题建议由“#”字符触发。建议在编辑器和源代码管理视图的输入框中可用。

建议中出现的问题可以通过 GitHub Issues: Queries (githubIssues.queries) 设置进行配置。查询使用 GitHub 搜索语法。

你还可以使用 GitHub Issues: Ignore Completion Trigger (githubIssues.ignoreCompletionTrigger) 和 GitHub Issues: Ignore User Completion Trigger (githubIssues.ignoreUserCompletionTrigger) 设置来配置哪些文件显示这些建议。这些设置接受一个语言标识符数组来指定文件类型。

// Languages that the '#' character should not be used to trigger issue completion suggestions.
"githubIssues.ignoreCompletionTrigger": [
  "python"
]

拉取请求

在拉取请求视图中，你可以查看、管理和创建拉取请求。

用于显示拉取请求的查询可以通过 GitHub Pull Requests: Queries (githubPullRequests.queries) 设置进行配置，并使用 GitHub 搜索语法。

"githubPullRequests.queries": [
    {
        "label": "Assigned To Me",
        "query": "is:open assignee:${user}"
    },

创建拉取请求

将更改提交到你的 fork 或分支后，你可以使用 GitHub Pull Requests: Create Pull Request 命令或拉取请求视图中的创建拉取请求按钮来创建拉取请求。

将显示一个新的创建视图，你可以在其中选择拉取请求要指向的基础仓库和基础分支，并填写标题和描述。如果你的仓库有拉取请求模板，它将自动用于描述。

使用顶部的操作栏中的按钮来添加受让人、审阅者、标签和里程碑。

创建按钮菜单允许你选择其他创建选项，例如创建草稿或启用自动合并方法。

选择创建后，如果你尚未将分支推送到 GitHub 远程仓库，扩展将询问你是否要发布分支，并提供一个下拉菜单来选择特定的远程仓库。

创建拉取请求视图现在进入审阅模式，你可以在其中审阅 PR 的详细信息、添加评论，并在准备就绪时合并 PR。PR 合并后，你将可以选择删除远程和本地分支。

审阅

拉取请求可以在拉取请求视图中进行审阅。你可以从拉取请求的描述中分配审阅者和标签、添加评论、批准、关闭和合并。

在描述页面，你还可以使用签出按钮轻松地在本地签出拉取请求。这会将 VS Code 切换为以审阅模式打开拉取请求的 fork 和分支（在状态栏中可见），并添加一个新的拉取请求中的更改视图，从中你可以查看当前更改以及所有提交及其中的更改的差异。已添加评论的文件将用菱形图标装饰。要查看磁盘上的文件，你可以使用打开文件内联操作。

此视图中的差异编辑器使用本地文件，因此文件导航、智能感知和编辑功能正常。你可以在编辑器内对这些差异添加评论。支持添加单个评论和创建整个审阅。

完成审阅拉取请求更改后，你可以合并 PR 或选择退出审阅模式以返回你之前正在处理的分支。

问题

创建问题

问题可以从问题视图中的 + 按钮创建，也可以使用 GitHub Issues: Create Issue from Selection 和 GitHub Issues: Create Issue from Clipboard 命令创建。它们还可以通过“TODO”注释的代码操作创建。创建问题时，你可以使用默认描述，或者选择右上角的编辑描述铅笔图标来调出问题正文的编辑器。

你可以使用 GitHub Issues: Create Issue Triggers (githubIssues.createIssueTriggers) 设置来配置代码操作的触发器。

默认的问题触发器是

"githubIssues.createIssueTriggers": [
  "TODO",
  "todo",
  "BUG",
  "FIXME",
  "ISSUE",
  "HACK"
]

处理问题

在问题视图中，你可以查看和处理你的问题。

默认情况下，当你开始处理一个问题时（开始处理问题上下文菜单项），将为你创建一个分支，如下图中状态栏所示。

状态栏还显示活动问题，如果你选择该项，会显示问题操作列表，例如在 GitHub 网站上打开问题或创建拉取请求。

你可以使用 GitHub Issues: Issue Branch Title (githubIssues.issueBranchTitle) 设置来配置分支的名称。如果你的工作流不涉及创建分支，或者如果你希望每次都被提示输入分支名称，你可以通过关闭 GitHub Issues: Use Branch For Issues (githubIssues.useBranchForIssues) 设置来跳过该步骤。

完成问题处理并想提交更改后，源代码管理视图中的提交消息输入框将填充一条消息，该消息可以使用 GitHub Issues: Working Issue Format SCM (githubIssues.workingIssueFormatScm) 进行配置。

GitHub Repositories 扩展

GitHub Repositories 扩展允许你直接在 Visual Studio Code 中快速浏览、搜索、编辑和提交到任何远程 GitHub 仓库，而无需在本地克隆仓库。这对于许多场景来说既快速又方便，你可能只需要审阅源代码或对文件或资产进行少量更改。

打开仓库

安装 GitHub Repositories 扩展后，你可以使用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的 GitHub Repositories: Open Repository... 命令，或者通过点击状态栏左下角的远程指示器来打开仓库。

当你运行打开仓库命令时，你可以选择是从 GitHub 打开仓库、从 GitHub 打开拉取请求，还是重新打开你之前连接过的仓库。

如果你之前没有从 VS Code 登录过 GitHub，系统会提示你使用 GitHub 账户进行身份验证。

你可以直接提供仓库 URL，或者在文本框中输入以在 GitHub 上搜索你想要的仓库。

选择仓库或拉取请求后，VS Code 窗口将重新加载，你会在文件资源管理器中看到仓库内容。然后，你可以打开文件（支持完整的语法高亮和括号匹配）、进行编辑并提交更改，就像在本地克隆仓库一样。

与本地仓库工作的一个区别是，当你使用 GitHub Repository 扩展提交更改时，更改会直接推送到远程仓库，这类似于你在 GitHub 网页界面中工作的情况。

GitHub Repositories 扩展的另一个功能是，每次你打开仓库或分支时，你都会获得 GitHub 上可用的最新源代码。你不需要像使用本地仓库那样记住拉取以刷新。

GitHub Repositories 扩展支持查看甚至提交 LFS 跟踪的文件，而无需在本地安装 Git LFS（大型文件系统）。将你希望使用 LFS 跟踪的文件类型添加到 .gitattributes 文件中，然后使用源代码管理视图直接将更改提交到 GitHub。

切换分支

通过点击状态栏中的分支指示器，你可以轻松地在分支之间切换。GitHub Repositories 扩展的一个出色功能是，你可以在不暂存未提交更改的情况下切换分支。该扩展会记住你的更改并在你切换分支时重新应用它们。

远程资源管理器

你可以使用活动栏上的远程资源管理器快速重新打开远程仓库。此视图显示你以前打开的仓库和分支。

创建拉取请求

如果你的工作流使用拉取请求而不是直接提交到仓库，你可以从源代码管理视图创建新的 PR。系统会提示你提供标题并创建新分支。

创建拉取请求后，你可以使用 GitHub Pull Request and Issues 扩展来审阅、编辑和合并你的 PR，如本主题前面所述。

虚拟文件系统

当你的本地机器上没有仓库文件时，GitHub Repositories 扩展会在内存中创建一个虚拟文件系统，以便你可以查看文件内容并进行编辑。使用虚拟文件系统意味着某些假定本地文件的操作和扩展将不被启用或功能受限。诸如任务、调试和集成终端等功能未启用，你可以通过远程指示器悬停中的功能不可用链接了解虚拟文件系统的支持级别。

扩展作者可以在虚拟工作区扩展作者指南中了解更多关于在虚拟文件系统和工作区中运行的信息。

继续工作...

有时，你可能希望切换到支持本地文件系统和完整语言及开发工具的开发环境中处理仓库。GitHub Repositories 扩展使你能够轻松地

• 创建 GitHub codespace（如果你安装了 GitHub Codespaces 扩展）。
• 在本地克隆仓库。
• 将仓库克隆到 Docker 容器中（如果你安装了 Docker 和 Microsoft Container Tools 扩展）。

要切换开发环境，请使用继续工作...命令，该命令可在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中找到，或者通过点击状态栏中的远程指示器。

如果你正在使用基于浏览器的编辑器，“继续工作...”命令提供在本地或在 GitHub Codespaces 的云托管环境中打开仓库的选项。

首次使用带有未提交更改的继续工作时，你将可以选择使用云更改将你的编辑带到你选择的开发环境，这会将你待处理的更改存储在用于设置同步的同一个 VS Code 服务上。

一旦这些更改应用到你的目标开发环境，它们就会从我们的服务中删除。如果你选择不带未提交更改继续，你始终可以通过配置设置 "workbench.cloudChanges.continueOn": "prompt" 来稍后更改此偏好。

如果你的待处理更改未自动应用到你的目标开发环境，你可以使用 Cloud Changes: Show Cloud Changes 命令查看、管理和删除你存储的更改。

后续步骤

• 了解更多关于 Copilot VS Code - 了解 VS Code 中的 Copilot。