部署的 REST API 端点

关于部署

部署是部署特定 ref（分支、SHA、标签）的请求。当创建新的部署时，GitHub 会分派一个 deployment 事件，外部服务可以侦听并对其进行操作。部署使开发人员和组织能够围绕部署构建松耦合的工具，而无需担心交付不同类型的应用程序（例如，Web、原生）的实现细节。

部署状态允许外部服务使用error、failure、pending、in_progress、queued 或 success 状态标记部署，这些状态可以被侦听 deployment_status 事件 的系统使用。

部署状态还可以包含可选的 description 和 log_url，强烈建议使用它们，因为它们使部署状态更有用。log_url 是部署输出的完整 URL，description 是部署发生情况的高级摘要。

创建新的部署和部署状态时，GitHub 会分派 deployment 和 deployment_status 事件。这些事件允许第三方集成接收和响应部署请求，并在部署取得进展时更新部署的状态。

以下是这些交互如何工作的简单顺序图。

+---------+             +--------+            +-----------+        +-------------+
| Tooling |             | GitHub |            | 3rd Party |        | Your Server |
+---------+             +--------+            +-----------+        +-------------+
     |                      |                       |                     |
     |  Create Deployment   |                       |                     |
     |--------------------->|                       |                     |
     |                      |                       |                     |
     |  Deployment Created  |                       |                     |
     |<---------------------|                       |                     |
     |                      |                       |                     |
     |                      |   Deployment Event    |                     |
     |                      |---------------------->|                     |
     |                      |                       |     SSH+Deploys     |
     |                      |                       |-------------------->|
     |                      |                       |                     |
     |                      |   Deployment Status   |                     |
     |                      |<----------------------|                     |
     |                      |                       |                     |
     |                      |                       |   Deploy Completed  |
     |                      |                       |<--------------------|
     |                      |                       |                     |
     |                      |   Deployment Status   |                     |
     |                      |<----------------------|                     |
     |                      |                       |                     |

请记住，GitHub 永远不会实际访问您的服务器。由您的第三方集成与部署事件交互。多个系统可以侦听部署事件，并且每个系统都需要自行决定它们是否负责将代码推送到您的服务器、构建本地代码等。

请注意，repo_deployment OAuth 范围 授予对部署和部署状态的目标访问权限，**而无需**授予对代码库代码的访问权限，而 public_repo 和 repo 范围也授予对代码的权限。

非活动部署

当您将部署的状态设置为 success 时，则同一代码库中具有相同环境名称的所有先前的非瞬态、非生产环境部署都将变为 inactive。为避免这种情况，您可以在创建部署状态时将 auto_inactive 设置为 false。

您可以通过将瞬态环境的 state 设置为 inactive 来传达该环境不再存在。将 state 设置为 inactive 会在 GitHub 中将部署显示为 destroyed 并删除对其的访问权限。