Skip to main content

个性化你帐户的 GitHub Codespaces

你可以通过使用 GitHub Enterprise Cloud 上的 dotfiles 存储库或使用“设置同步”来个性化 GitHub Codespaces。

关于个性化 Codespaces

在使用任何开发环境时,根据您的喜好和工作流程自定义设置和工具是一个重要步骤。 GitHub Codespaces 支持两种将 codespace 个性化的主要方法。

  • 设置同步 - 可以在桌面应用程序与 VS Code Web 客户端之间同步 Visual Studio Code 设置。
  • Dotfiles - 可以使用 dotfiles 存储库指定脚本、shell 首选项和其他配置。

GitHub Codespaces 个性化适用于你创建的任何代码空间。

项目维护员还可以定义默认配置,将应用到任何人创建的仓库的每个代码空间。 有关详细信息,请参阅“开发容器简介”。

设置同步

设置同步可让你在机器和 VS Code 实例中同步配置,如设置、键盘快捷方式、片段、扩展和 UI 状态。 有关详细信息,请参阅 VS Code 文档中的“设置同步”。

在 VS Code 实例(例如笔记本电脑上的 VS Code 桌面应用程序)中启用设置同步时,该实例的设置将存储在云中。 设置在创建时从云中拉入所有新 codespace,并持续同步到启用了设置同步的任何现有 codespace。

默认是否在 codespace 中启用设置同步取决于现有设置,以及是在浏览器还是在 VS Code 桌面应用程序中打开 codespace。

  • 如果在浏览器中打开一个 codespace,则首先始终禁用“设置同步”。 这意味着一次只能单向转移设置:GitHub Codespaces 在创建时将云中存储的设置拉取到 codespace 中,但对 codespace 中的设置所进行的任何更新不会传播到云,因而也不会反映在任何其他 codespace 中。 同样,对其他位置的设置所进行的任何更新都不会反映在 codespace 中。
  • 在 VS Code 桌面应用程序中打开 codespace 时,如果之前为该应用程序启用了设置同步,则设置同步在该 codespace 中也处于启用状态。 对设置所进行的任何更新将被推送到云中,因此更新会反映在新的 codespace 中和已启用设置同步的任何现有 codespace 中。 如果对已启用设置同步的其他 VS Code 实例中的设置进行更新,则这些更新会反映在 codespace。

如果使用的是已禁用设置同步的 codespace,则可以启用设置同步,以便将对设置所做的更改推送到云,或拉取在其他位置对设置所做的最新更改。

启用设置同步

注意:应仅在从信任的存储中创建的 codespace 中启用设置同步。 有关详细信息,请参阅“GitHub Codespaces 中的安全性”。

  1. 在 VS Code 中的“活动栏”的底部,选择 并单击“打开设置同步…”

  2. 在下拉列表中,选择要同步的设置。

    “设置同步”选项的屏幕截图

  3. 单击“登录并启用”,然后选择要将设置同步到的帐户。

登录后,会立即更新你正在使用的 VS Code 实例,以显示最新的同步设置。

禁用设置同步

可以禁用设置同步以停止与 VS Code 的实例之间的设置同步。

默认情况下,禁用设置同步时,新 codespace 将继续使用上次将设置推送到云时缓存的设置。 如果仍在使用缓存的设置创建 codespace,而你想要恢复使用 codespace 中的默认 VS Code 设置,则可以在禁用设置同步的同时清除云中的缓存。

  1. 如果当前在 VS Code 的实例中禁用了设置同步,必须先启用它。 有关说明,请参阅“启用设置同步”。

  2. 在活动栏底部,选择 ,然后单击“设置同步已打开”。

  3. 在下拉列表中,单击“设置同步: 关闭”。

    VS Code 中的设置同步关闭选项的屏幕截图

  4. 若要清除缓存的设置,请在对话框中选择“关闭所有设备上的同步并清除云中的数据”。

    “关闭设置同步”对话框的屏幕截图

  5. 单击“关闭”。

Dotfiles

Dotfiles 是类似 Unix 的系统上以 . 开头的文件和文件夹,用于控制系统上应用程序和 shell 的配置。 您可以在 GitHub 上的仓库中存储和管理 dotfiles。 有关 dotfiles 存储库中所含内容的建议和教程,请参阅 GitHub 执行 dotfiles

dotfiles 仓库可能包括 shell 别名和首选项、您想要安装的任何工具或您想要执行的任何其他代码个性化。

可以在个人 GitHub Codespaces 设置中选择存储库,将 GitHub Codespaces 配置为使用你拥有的任何存储库中的 dotfiles。

创建新的 codespace 时,GitHub 会将所选点文件存储库克隆到 codespace 环境,并查找以下文件之一来设置环境。

  • install.sh
  • install
  • bootstrap.sh
  • bootstrap
  • script/bootstrap
  • setup.sh
  • setup
  • script/setup

如果未找到这些文件,则所选 dotfiles 存储库中以 . 开头的文件或文件夹通过符号链接到代码空间的 ~$HOME 目录。

对所选 dotfiles 仓库所做的任何更改只会应用到每个新的代码空间,而不影响任何现有的代码空间。

注意:目前,Codespaces 不支持通过 dotfiles 存储库将 VS Code 的用户范围的设置进行个性化。 可以为项目存储库中的特定项目设置默认“工作区”和“远程 [Codespaces]”设置。 有关详细信息,请参阅“开发容器简介”。

为 Codespaces 启用 dotfiles 存储库

可以使用所选的 dotfiles 存储库来将 GitHub Codespaces 环境个性化。 选择 dotfiles 存储库后,可以向其中添加脚本、首选项和配置。 然后,需要从个人 GitHub Codespaces 设置页面启用 dotfiles。

警告:Dotfiles 能够运行任意脚本,这些脚本可能包含意外或恶意代码。 在安装 dotfiles 存储库之前,我们建议检查脚本以确保它们不会执行任何意外操作。

  1. 在任何页面的右上角,单击个人资料照片,然后单击“设置”。

    用户栏中的 Settings 图标 1. 在边栏的“代码、规划和自动化”部分中,单击“ Codespaces”。

  2. 在“Dotfiles”下,选择“自动安装 dotfiles”,以便 GitHub Codespaces 自动将 dotfiles 安装到你创建的每个新 codespace 中。 安装 dotfiles

  3. 选择要从中安装 dotfile 的存储库。 选择 dotfiles 存储库

您可以随时将更多脚本、首选项、配置文件添加到 dotfiles 存储库或编辑现有文件。 对设置的更改将仅由新的代码空间选取。

如果 codespace 无法从点文件中选取配置设置,请参阅“排查 GitHub Codespaces 的个性化选项问题”。

其他可用设置

还可以使用个人设置中的其他选项对 GitHub Codespaces 进行个性化设置:

延伸阅读