app.deploys stellt das DeploysModule bereit, das sowohl die Deploy-Timeline als auch die beiden GitHub-Integrationswege abdeckt.
Den Deploy-Verlauf auflisten
app.deploys.list() gibt Deployment[][] zurück — ein inneres Array pro Deploy, das jeweils die Lebenszyklus-Zustände durchläuft: pending → clone → commit → restarting → success | error.
Reduziere das Ergebnis, wenn du eine einzige chronologische Liste möchtest:
In v3 gab diese Methode ein flaches Deployment[] zurück. v4 gibt Deployment[][] zurück, damit du Ereignisse nach Deploy gruppieren kannst. Verwende .flat(), um die alte Form beizubehalten.
Deployment.id ist nun ein einfacher Commit-SHA-1 (40 Hex-Zeichen). In v3 war er als `git-${string}` formatiert.
Verknüpfen über die Square Cloud GitHub App (empfohlen)
app.deploys.linkGithubApp({ repositoryName, repositoryBranch }) verknüpft ein GitHub-Repository über die offizielle GitHub App mit der Anwendung.
Um die Verknüpfung zu entfernen:
linkGithubApp und unlinkGithubApp erfordern ein Session-Token (JWT) als API-Schlüssel — einfache API-Schlüssel werden von diesen Endpoints nicht akzeptiert.
Verknüpfen über den klassischen Webhook-Ablauf
app.deploys.integrateGithubWebhook(accessToken) konfiguriert die klassische Webhook-basierte Integration mit einem GitHub Personal Access Token.
Übergib "@", um den Webhook zu entfernen:
Die aktuelle Konfiguration einsehen
app.deploys.current() gibt die aktuell konfigurierte GitHub-App-Verknüpfung und Webhook-URL zurück, sofern vorhanden.
Es gibt außerdem eine Abkürzung app.deploys.webhookURL(), die nur die Webhook-URL zurückgibt (oder undefined).