SDK de JavaScript: deploys desde GitHub

api.apps.deploys conecta una aplicación a GitHub para que un push la despliegue. Hay dos formas de hacerlo: un webhook que añades al repositorio, o la GitHub App de Square Cloud. Los ejemplos usan el cliente api de Crear el cliente. appId es el id de una de tus aplicaciones: api.account.me() las lista.

Webhook

deploys.setWebhook(appId, accessToken) configura los deploys por webhook de GitHub con un token de acceso de GitHub (ghp_... o github_pat_...) y devuelve la URL del webhook que debes añadir a tu repositorio.

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

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

Pasa "@" como token para eliminar el webhook. En ese caso, el método devuelve "".

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

Un token no válido da 400 INVALID_ACCESS_TOKEN.

GitHub App

deploys.linkGithubApp(appId, repository, branch) vincula un repositorio instalado a través de la GitHub App de Square Cloud. Necesita el 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) elimina la vinculación. Para vincular otro repositorio o rama, desvincula primero.

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

Vincular y desvincular comparten un límite de 3 llamadas cada 60 segundos.

Estado	Código	Cuándo
400	`GIT_ALREADY_CONFIGURED`	La aplicación ya tiene un repositorio vinculado: desvincúlalo primero
400	`GIT_NOT_CONFIGURED`	`unlinkGithubApp` sin nada vinculado
400	`BRANCH_NOT_FOUND`, `INVALID_BRANCH_LENGTH`	La rama no existe, o su nombre supera los 256 caracteres
403	`GITHUB_NOT_CONNECTED`	Tu cuenta no tiene ninguna instalación de la GitHub App
403	`REPOSITORY_NOT_AVAILABLE`	La GitHub App no está instalada en el repositorio a través de tu cuenta de GitHub
403	`REPOSITORY_PERMISSION_REQUIRED`	Tu cuenta de GitHub no tiene acceso de escritura al repositorio
404	`REPOSITORY_NOT_FOUND`	El repositorio no existe o no es visible
409	`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	Otra aplicación, de cualquier cuenta, ya vincula este repositorio y esta rama. Su id aparece en `message` solo cuando esa aplicación es tuya
502	`FAILED_TO_FETCH`	GitHub no confirmó la rama: se puede reintentar sin riesgo

Configuración actual

deploys.current(appId) devuelve lo que está configurado: app para la vinculación con la GitHub App, webhook para la URL del webhook. Devuelve {} cuando no hay nada configurado.

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);

Historial de deploys

deploys.list(appId) devuelve una línea de tiempo por deploy, cada una un array de eventos, del evento más antiguo al más reciente. Solo se registran los deploys de Git (pushes por webhook y por 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	Descripción
`id`	El SHA del commit
`state`	`pending`, `clone`, `commit`, `restarting`, `success` o `error`
`date`	Cuándo ocurrió el evento
`source`	Siempre `"git"`
`branch`	En los eventos `clone`
`files`	En los eventos `commit`: `{ added, removed, modified }`
`code` / `message`	En los eventos `error`: por qué falló el deploy (por ejemplo `CLONE_FAILED`)

Próximos pasos

Red

Analíticas, DNS, dominios personalizados y caché.

Referencia de la API de deploys

Los endpoints REST detrás de estos métodos.

Deploys de GitHub desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de JavaScript: deploys desde GitHub

Webhook

GitHub App

Configuración actual

Historial de deploys

Próximos pasos

Red

Referencia de la API de deploys

Deploys de GitHub desde la CLI

​Webhook

​GitHub App

​Configuración actual

​Historial de deploys

​Próximos pasos

Red

Referencia de la API de deploys

Deploys de GitHub desde la CLI

Webhook

GitHub App

Configuración actual

Historial de deploys

Próximos pasos