Skip to main content
app.deploys expose le DeploysModule, qui couvre à la fois la chronologie des deploys et les deux voies d’intégration GitHub.

Lister l’historique des deploys

app.deploys.list() renvoie Deployment[][]un tableau interne par deploy, chacun parcourant les états du cycle de vie : pending → clone → commit → restarting → success | error.
Aplatissez le résultat si vous voulez une seule liste chronologique :
En v3, cette méthode renvoyait un Deployment[] plat. La v4 renvoie Deployment[][] afin que vous puissiez regrouper les événements par deploy. Utilisez .flat() pour conserver l’ancienne forme.
Deployment.id est désormais un simple SHA-1 de commit (40 caractères hexadécimaux). En v3, il était formaté comme `git-${string}`.

Lier via la GitHub App Square Cloud (recommandé)

app.deploys.linkGithubApp({ repositoryName, repositoryBranch }) lie un dépôt GitHub à l’application via la GitHub App officielle.
Pour supprimer le lien :
linkGithubApp et unlinkGithubApp nécessitent un token de session (JWT) comme clé d’API — les clés d’API simples ne sont pas acceptées par ces endpoints.

Lier via l’ancien flux webhook

app.deploys.integrateGithubWebhook(accessToken) configure l’ancienne intégration basée sur les webhooks à l’aide d’un GitHub Personal Access Token.
Passez "@" pour supprimer le webhook :

Inspecter la configuration actuelle

app.deploys.current() renvoie la liaison GitHub App et l’URL du webhook actuellement configurées, le cas échéant.
Il existe également un raccourci app.deploys.webhookURL() qui ne renvoie que l’URL du webhook (ou undefined).