Skip to main content

配置自定义部署保护规则

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

谁可以使用此功能?

自定义部署保护规则在所有计划的公共存储库中可用。 要访问专用存储库或内部存储库中的自定义部署保护规则,必须使用 GitHub Enterprise。

注意: 自定义部署保护规则目前为 beta 版本,可能随时更改。

关于自定义部署保护规则

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

在环境中启用自定义部署保护规则后,每当工作流步骤瞄准该环境时,部署保护规则都将自动运行。 有关瞄准要部署的环境的详细信息,请参阅“管理部署环境”。

触发自定义部署保护规则时,将有长达 30 天的 Webhook 事件响应等待,然后出现超时且工作流作业失败。

有关创建自己的自定义部署保护规则的详细信息,请参阅“创建自定义部署保护规则”。

注意:可以在存储库中安装任意数量的基于 GitHub Apps 的部署保护规则。 但是,最多可以同时在环境中启用 6 个部署保护规则。

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

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

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

先决条件

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

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

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

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

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

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏中,单击“环境”。

  4. 选择要配置的环境。

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

  6. 单击“保存保护规则”。

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