Skip to main content
app.deploys 暴露了 DeploysModule,它同时涵盖部署时间线和两种 GitHub 集成路径。

列出部署历史

app.deploys.list() 返回 Deployment[][] —— 每个内层数组对应一次部署,各自贯穿生命周期状态:pending → clone → commit → restarting → success | error
如果你想要一个单一的按时间顺序排列的列表,可以将结果展平:
在 v3 中,此方法返回一个扁平的 Deployment[]。v4 返回 Deployment[][],以便你可以按部署对事件进行分组。使用 .flat() 保持旧的结构。
Deployment.id 现在是一个纯粹的提交 SHA-1(40 位十六进制字符)。在 v3 中它被格式化为 `git-${string}`

通过 Square Cloud GitHub App 关联(推荐)

app.deploys.linkGithubApp({ repositoryName, repositoryBranch }) 通过官方 GitHub App 将一个 GitHub 仓库关联到应用。
要移除关联:
linkGithubAppunlinkGithubApp 要求使用 会话令牌(JWT) 作为你的 API 密钥 —— 这些 endpoint 不接受普通的 API 密钥。

通过旧版 webhook 流程关联

app.deploys.integrateGithubWebhook(accessToken) 使用 GitHub 个人访问令牌配置旧版基于 webhook 的集成。
传入 "@" 以移除该 webhook:

查看当前配置

app.deploys.current() 返回当前已配置的 GitHub App 关联和 webhook URL(如果有)。
还有一个快捷方法 app.deploys.webhookURL(),它只返回 webhook URL(或 undefined)。