在 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 拉取请求和问题入门

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

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

设置存储库

克隆存储库

您可以使用命令面板中的 Git: Clone 命令（⇧⌘P（Windows、Linux Ctrl+Shift+P））搜索和克隆 GitHub 存储库，或使用源代码管理视图中的克隆存储库按钮（在未打开文件夹时可用）。

从 GitHub 存储库下拉列表中，您可以筛选并选择要本地克隆的存储库。

使用现有存储库进行身份验证

在 VS Code 中运行任何需要 GitHub 身份验证的 Git 操作（例如推送到您是成员的存储库或克隆私有存储库）时，会启用通过 GitHub 的身份验证。您无需安装任何特殊扩展即可进行身份验证；它内置于 VS Code 中，以便您可以高效地管理存储库。

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

按照步骤登录 GitHub 并返回 VS Code。仅 GitHub Enterprise Server 支持使用个人访问令牌 (PAT) 登录。如果您正在使用 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}"
    },

创建拉取请求

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

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

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

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

选择创建后，如果您尚未将分支推送到 GitHub 远程，扩展将询问您是否要发布该分支，并提供下拉列表以选择特定的远程。

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

审阅

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

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

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

审阅完拉取请求更改后，您可以合并拉取请求，或选择退出审阅模式返回到您之前工作的分支。

问题

创建问题

可以从问题视图中的 + 按钮以及使用 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 扩展后，您可以使用命令面板中的 GitHub Repositories: Open Repository... 命令（⇧⌘P（Windows、Linux Ctrl+Shift+P）），或单击状态栏左下角的远程指示器来打开存储库。

运行打开存储库命令时，您可以选择从 GitHub 打开存储库、从 GitHub 打开拉取请求，或重新打开您之前连接过的存储库。

如果您之前未从 VS Code 登录 GitHub，系统将提示您使用您的 GitHub 帐户进行身份验证。

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

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

与处理本地存储库不同的是，当您使用 GitHub Repository 扩展提交更改时，更改会直接推送到远程存储库，类似于在 GitHub Web 界面中工作。

GitHub Repositories 扩展的另一个功能是，每次打开存储库或分支时，都会获取 GitHub 上的最新源。您无需记住像使用本地存储库那样拉取以刷新。

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

切换分支

您可以通过单击状态栏中的分支指示器轻松切换分支。GitHub Repositories 扩展的一个很棒的功能是，您无需暂存未提交的更改即可切换分支。该扩展会记住您的更改并在您切换分支时重新应用它们。

远程资源管理器

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

创建拉取请求

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

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

虚拟文件系统

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

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

继续工作于...

有时，您会想切换到在支持本地文件系统以及完整语言和开发工具的开发环境中处理存储库。GitHub Repositories 扩展使您可以轻松地进行以下操作：

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

要切换开发环境，请使用命令面板中的 继续工作于... 命令（⇧⌘P（Windows、Linux Ctrl+Shift+P）），或单击状态栏中的远程指示器。

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

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

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

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

后续步骤

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