配置自定义部署保护规则

使用 GitHub Apps 自动保护使用第三方系统的部署。

谁可以使用此功能？

自定义部署保护规则在所有计划的公共存储库中可用。要访问私有或内部存储库中的自定义部署保护规则，您必须使用 GitHub Enterprise。有关详细信息，请参阅“GitHub 的计划”。

本文内容

注意

自定义部署保护规则目前处于公开预览阶段，可能会发生变化。

关于自定义部署保护规则

自定义部署保护规则由 GitHub Apps 提供支持。配置并安装存储库中的部署保护规则后，可以将其启用为存储库中的任何环境。

在环境上启用自定义部署保护规则后，每次工作流步骤针对该环境时，部署保护规则都会自动运行。有关将环境作为部署目标的信息，请参阅“管理部署环境”。

触发自定义部署保护规则后，它将等待 Webhook 事件响应长达 30 天，然后超时并导致工作流作业失败。

有关创建您自己的自定义部署保护规则的更多信息，请参阅“创建自定义部署保护规则”。

注意

可以在存储库上安装任意数量的基于 GitHub Apps 的部署保护规则。但是，在任何环境上同时启用的部署保护规则最多只能有 6 个。

使用现有的自定义部署保护规则

您可以选择创建自己的自定义部署保护规则，也可以使用任何现有的自定义部署保护规则。

以下是部署保护规则的官方合作伙伴实现列表。

先决条件

为了使自定义部署保护规则可用于存储库中的所有环境，您必须先在存储库上安装自定义部署保护规则。有关更多信息，请参阅“安装您自己的 GitHub 应用”。

在存储库中安装自定义部署保护规则后，必须为要应用规则的每个环境启用它。

为环境启用自定义部署保护规则

  1. 在 GitHub 上，导航到存储库的主页。

  2. 在您的存储库名称下，单击 **设置**。如果您看不到“设置”选项卡，请选择****下拉菜单，然后单击**设置**。

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在左侧边栏中，单击**环境**。

  4. 选择您要配置的环境。

  5. 在“部署保护规则”下，选中您要为环境启用的每个自定义部署保护规则旁边的复选框。

  6. 单击**保存保护规则**。

为环境启用自定义部署保护规则后，每当工作流到达引用该环境的作业时，它都会自动运行。您可以通过查看部署的详细信息来查看部署批准或拒绝的结果。有关更多信息，请参阅“查看部署”。