SDK Go: deploy da GitHub

c.Apps.Deploys collega un’app a GitHub in modo che un push ne effettui il deploy. Ci sono due modi per farlo: un webhook da aggiungere al repository, oppure la GitHub App di Square Cloud. Ogni snippet qui sotto funziona da solo all’interno di questo programma: incollane uno alla volta in main ed esegui goimports (vedi Eseguire gli esempi).

package main

import (
	"context"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

var (
	ctx   = context.Background()
	c     = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID = "abc123def456abc123def456"
)

func main() {
	// Paste one snippet here, then run goimports.
}

Webhook

Deploys.SetWebhook(ctx, 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.

url, err := c.Apps.Deploys.SetWebhook(ctx, appID, os.Getenv("GITHUB_TOKEN"))
if err != nil {
	log.Fatal(err)
}

fmt.Println(url) // add it as a webhook in the repository settings

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

if _, err := c.Apps.Deploys.SetWebhook(ctx, appID, "@"); err != nil {
	log.Fatal(err)
}

Un token non valido produce 400 INVALID_ACCESS_TOKEN.

GitHub App

Deploys.LinkGithubApp(ctx, appID, repository, branch) collega un repository installato tramite la GitHub App di Square Cloud. Richiede lo scope apps:deploy.

repo, err := c.Apps.Deploys.LinkGithubApp(ctx, appID, "octocat/hello-world", "main")
if err != nil {
	log.Fatal(err)
}

fmt.Println(repo.ID, repo.FullName, repo.Branch)

Deploys.UnlinkGithubApp(ctx, appID) rimuove il collegamento. Per collegare un altro repository o branch, scollega prima quello attuale.

if err := c.Apps.Deploys.UnlinkGithubApp(ctx, appID); err != nil {
	log.Fatal(err)
}

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 è presente 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(ctx, appID) restituisce ciò che è configurato: App per il collegamento alla GitHub App, Webhook per l’URL del webhook. Quando non è impostato nulla, restituisce il valore zero (App è nil e Webhook è ""). I campi di App sono puntatori, poiché l’API può inviarli come null.

current, err := c.Apps.Deploys.Current(ctx, appID)
if err != nil {
	log.Fatal(err)
}

if app := current.App; app != nil && app.Name != nil && app.Branch != nil {
	fmt.Println(*app.Name, *app.Branch) // e.g. "octocat/hello-world" "main"
}
if current.Webhook != "" {
	fmt.Println(current.Webhook)
}

Cronologia dei deploy

Deploys.List(ctx, appID) restituisce una timeline per ogni deploy (un [][]DeployEvent), ciascuna uno slice di eventi, dal più vecchio. Vengono registrati solo i deploy Git (push tramite webhook e GitHub App).

timelines, err := c.Apps.Deploys.List(ctx, appID)
if err != nil {
	log.Fatal(err)
}
for _, timeline := range timelines {
	if len(timeline) == 0 {
		continue
	}
	last := timeline[len(timeline)-1]
	fmt.Println(last.ID, last.State, last.Date)

	if last.State == squarecloud.DeployError {
		fmt.Println(last.Code, last.Message)
	}
}

Campo	Descrizione
`ID` (`id`)	Lo SHA del commit
`State` (`state`)	`pending`, `clone`, `commit`, `restarting`, `success` o `error` (costanti `DeployPending`, `DeployClone`, `DeployCommit`, `DeployRestarting`, `DeploySuccess`, `DeployError`)
`Date` (`date`)	Quando è avvenuto l’evento (`time.Time`)
`Source` (`source`)	Sempre `"git"`
`Branch` (`branch`)	Negli eventi `clone`
`Files` (`files`)	Negli eventi `commit`: un `*DeployFiles` con `Added`, `Removed` e `Modified`; `nil` altrimenti
`Code` / `Message` (`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 Go: 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