管理存储库或组织的开发环境密钥

开发环境密钥允许您将敏感信息存储在您的组织或存储库中，以供 GitHub Codespaces 使用。

谁可以使用此功能？

要管理 GitHub Codespaces 组织的开发环境密钥，您必须是组织所有者。

开发环境密钥在所有公共存储库、个人帐户拥有的私有存储库以及 GitHub 团队或 GitHub Enterprise 计划上的组织拥有的私有存储库中可用。有关更多信息，请参阅“GitHub 的计划”。

本文内容

关于密钥

开发环境密钥是您在组织、存储库或个人帐户的 GitHub Codespaces 设置中创建的加密环境变量。本文介绍如何管理组织密钥和存储库密钥。有关创建用户特定密钥的信息，请参阅“管理您的帐户特定密钥以供 GitHub Codespaces 使用”。

您创建的开发环境密钥可在 GitHub Codespaces 中使用。GitHub 使用 libsodium 密封盒在密钥到达 GitHub 之前对其进行加密，并且仅在您在 Codespace 中使用它们时才对其进行解密。

组织密钥允许您在多个存储库之间共享密钥，从而减少了创建重复密钥的需要。您可以使用访问策略来控制哪些存储库可以使用组织密钥。

创建密钥后，在创建新的 Codespace 或重新启动 Codespace 时，它将可用。如果您已在 GitHub 上创建密钥并希望在当前运行的 Codespace 中使用它，请停止 Codespace，然后重新启动它。有关停止 Codespace 的信息，请参阅“在 GitHub Codespaces 中使用 Visual Studio Code 命令面板”。

密钥命名

以下规则适用于密钥名称

密钥名称只能包含字母数字字符 ([a-z]、[A-Z]、[0-9]) 或下划线 (_)。不允许使用空格。
密钥名称不得以 GITHUB_ 前缀开头。
密钥名称不得以数字开头。
密钥名称不区分大小写。
密钥名称在其创建的级别上必须唯一。例如，在存储库级别创建的密钥必须在该存储库中具有唯一的名称，而在组织级别创建的密钥必须在该级别上具有唯一的名称。

如果多个层级存在同名的密钥，则最低层级的密钥优先。例如，如果组织级密钥与仓库级密钥同名，则仓库级密钥优先。

密钥限制

每个组织最多可以存储 100 个密钥，每个仓库最多可以存储 100 个密钥。

密钥大小限制为 48 KB。

您的项目可能需要特定的用户密钥。例如，要在 Codespace 中运行应用程序，用户可能需要提供个人 API 密钥。如果是这种情况，您可以在开发容器配置中指定推荐密钥。然后，如果用户尚未创建这些个人密钥，当他们使用高级选项页面创建 Codespace 时，系统会提示他们为这些密钥提供值。如果用户提供了要在 Codespace 中使用的密钥值，则此密钥将添加到其 Codespaces 的个人设置中。将来，当他们为此仓库创建 Codespace 时，无需再次输入此密钥的值。有关更多信息，请参阅“为仓库指定推荐密钥”。

添加仓库密钥

要为组织仓库创建开发环境密钥，您必须具有管理员访问权限。

在 GitHub 上，导航到仓库的主页。
在您的仓库名称下，单击设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。
在侧边栏的“安全”部分，选择 密钥和变量，然后单击Codespaces。
在页面顶部，单击新建仓库密钥。
在名称输入框中键入密钥的名称。
输入密钥的值。
单击添加密钥。

添加组织密钥

在组织中创建开发环境密钥时，您可以使用策略来限制哪些仓库可以访问该密钥。例如，您可以授予所有仓库访问权限，或仅限于私有仓库或指定仓库列表的访问权限。

要创建组织级密钥，您必须具有admin访问权限。

在 GitHub 上，导航到组织的主页。
在您的组织名称下，单击设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。
在侧边栏的“安全”部分，选择 密钥和变量，然后单击Codespaces。
在页面顶部，单击新建密钥。
在名称输入框中键入密钥的名称。
输入密钥的值。
从仓库访问下拉列表中选择访问策略。
单击添加密钥。

查看组织级密钥的访问权限

您可以检查组织中应用于开发环境密钥的访问策略。

在 GitHub 上，导航到组织的主页。
在您的组织名称下，单击设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。
在侧边栏的“安全”部分，选择 密钥和变量，然后单击Codespaces。
可选地，要查看或编辑每个密钥的配置权限，请在密钥右侧单击.

进一步阅读

"管理您针对 GitHub Codespaces 的帐户特定密钥"