SDK JavaScript: deploy da GitHub

api.apps.deploys collega un’app a GitHub in modo che un push ne esegua il deploy. Ci sono due modi per farlo: un webhook che aggiungi al repository, oppure la GitHub App di Square Cloud. Gli esempi usano il client api di Creare il client. appId è l’id di una delle tue app: api.account.me() le elenca.

Webhook

deploys.setWebhook(appId, accessToken) configura i deploy tramite webhook di GitHub con un token di accesso GitHub (ghp_... o github_pat_...) e restituisce l’URL del webhook da aggiungere al tuo repository.

const url = await api.apps.deploys.setWebhook(appId, process.env.GITHUB_TOKEN!);

console.log(url); // add it as a webhook in the repository settings

Passa "@" come token per rimuovere il webhook. In quel caso il metodo restituisce "".

await api.apps.deploys.setWebhook(appId, "@");

Un token non valido produce 400 INVALID_ACCESS_TOKEN.

GitHub App

deploys.linkGithubApp(appId, repository, branch) collega un repository installato tramite la GitHub App di Square Cloud. Richiede lo scope apps:deploy.

const repo = await api.apps.deploys.linkGithubApp(appId, "octocat/hello-world", "main");

console.log(repo.id, repo.full_name, repo.branch);

deploys.unlinkGithubApp(appId) rimuove il collegamento. Per collegare un altro repository o branch, scollega prima quello attuale.

await api.apps.deploys.unlinkGithubApp(appId);

Collegamento e scollegamento condividono un limite di 3 chiamate ogni 60 secondi.

Status	Codice	Quando
400	`GIT_ALREADY_CONFIGURED`	L’app ha già un repository collegato: scollegalo prima
400	`GIT_NOT_CONFIGURED`	`unlinkGithubApp` senza nulla di collegato
400	`BRANCH_NOT_FOUND`, `INVALID_BRANCH_LENGTH`	Il branch non esiste, oppure il suo nome supera i 256 caratteri
403	`GITHUB_NOT_CONNECTED`	Il tuo account non ha un’installazione della GitHub App
403	`REPOSITORY_NOT_AVAILABLE`	La GitHub App non è installata sul repository tramite il tuo account GitHub
403	`REPOSITORY_PERMISSION_REQUIRED`	Il tuo account GitHub non ha accesso in scrittura al repository
404	`REPOSITORY_NOT_FOUND`	Il repository non esiste o non è visibile
409	`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	Un’altra app, di qualsiasi account, collega già questo repository e branch. Il suo id compare in `message` solo quando quell’app è tua
502	`FAILED_TO_FETCH`	GitHub non ha confermato il branch: puoi riprovare in sicurezza

Configurazione attuale

deploys.current(appId) restituisce ciò che è configurato: app per il collegamento alla GitHub App, webhook per l’URL del webhook. Restituisce {} quando non c’è nulla di impostato.

const { app, webhook } = await api.apps.deploys.current(appId);

if (app) console.log(app.name, app.branch); // e.g. "octocat/hello-world" "main"
if (webhook) console.log(webhook);

Cronologia dei deploy

deploys.list(appId) restituisce una timeline per ogni deploy, ciascuna un array di eventi, dal più vecchio. Vengono registrati solo i deploy Git (push tramite webhook e GitHub App).

for (const timeline of await api.apps.deploys.list(appId)) {
    const last = timeline.at(-1);
    console.log(last?.id, last?.state, last?.date);

    if (last?.state === "error") console.log(last.code, last.message);
}

Campo	Descrizione
`id`	Lo SHA del commit
`state`	`pending`, `clone`, `commit`, `restarting`, `success` o `error`
`date`	Quando è avvenuto l’evento
`source`	Sempre `"git"`
`branch`	Negli eventi `clone`
`files`	Negli eventi `commit`: `{ added, removed, modified }`
`code` / `message`	Negli eventi `error`: perché il deploy è fallito (ad esempio `CLONE_FAILED`)

Prossimi passi

Rete

Analytics, DNS, domini personalizzati e cache.

Riferimento API dei deploy

Gli endpoint REST dietro questi metodi.

Deploy da GitHub con la CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK JavaScript: deploy da GitHub

Webhook

GitHub App

Configurazione attuale

Cronologia dei deploy

Prossimi passi

Rete

Riferimento API dei deploy

Deploy da GitHub con la CLI

​Webhook

​GitHub App

​Configurazione attuale

​Cronologia dei deploy

​Prossimi passi

Rete

Riferimento API dei deploy

Deploy da GitHub con la CLI

Webhook

GitHub App

Configurazione attuale

Cronologia dei deploy

Prossimi passi