Skip to main content
app.deploys expõe o DeploysModule, que cobre tanto a linha do tempo dos deploys quanto os dois caminhos de integração com o GitHub.

Listando o histórico de deploys

app.deploys.list() retorna Deployment[][]um array interno por deploy, cada um percorrendo os estados: pending → clone → commit → restarting → success | error.
Use .flat() se quiser uma única lista cronológica:
Na v3 esse método retornava um Deployment[] plano. A v4 retorna Deployment[][] para agrupar eventos por deploy. Use .flat() para manter o formato antigo.
Deployment.id agora é um SHA-1 de commit (40 chars hex). Na v3 era formatado como `git-${string}`.

Vinculando via GitHub App da Square Cloud (recomendado)

app.deploys.linkGithubApp({ repositoryName, repositoryBranch }) vincula um repositório GitHub à aplicação por meio do GitHub App oficial.
Para remover o vínculo:
linkGithubApp e unlinkGithubApp exigem um session token (JWT) como chave de API — chaves de API comuns não são aceitas nesses endpoints.

Vinculando via webhook (legado)

app.deploys.integrateGithubWebhook(accessToken) configura a integração legada por webhook usando um Personal Access Token do GitHub.
Passe "@" para remover o webhook:

Inspecionando a configuração atual

app.deploys.current() retorna o vínculo do GitHub App e a URL do webhook configurada, se houver.
Há também o atalho app.deploys.webhookURL(), que retorna apenas a URL do webhook (ou undefined).