Go-SDK: GitHub-Deploys

c.Apps.Deploys verbindet eine App mit GitHub, sodass ein Push sie deployt. Dafür gibt es zwei Wege: einen Webhook, den du dem Repository hinzufügst, oder die Square Cloud GitHub App. Jedes Snippet unten läuft für sich allein in diesem Programm: Füge jeweils eines in main ein und führe goimports aus (siehe Beispiele ausführen).

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) konfiguriert Deploys per GitHub-Webhook mit einem GitHub-Zugriffstoken (ghp_... oder github_pat_...) und gibt die Webhook-URL zurück, die du deinem Repository hinzufügst.

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

Übergib "@" als Token, um den Webhook zu entfernen. Die Methode gibt dann "" zurück.

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

Ein ungültiges Token ergibt 400 INVALID_ACCESS_TOKEN.

GitHub App

Deploys.LinkGithubApp(ctx, appID, repository, branch) verknüpft ein Repository, das über die Square Cloud GitHub App installiert ist. Dafür ist der Scope apps:deploy nötig.

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) entfernt die Verknüpfung. Um ein anderes Repository oder einen anderen Branch zu verknüpfen, hebe die Verknüpfung zuerst auf.

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

Verknüpfen und Aufheben teilen sich ein Limit von 3 Aufrufen pro 60 Sekunden.

Status	Code	Wann
400	`GIT_ALREADY_CONFIGURED`	Die App hat bereits ein verknüpftes Repository: Hebe die Verknüpfung zuerst auf
400	`GIT_NOT_CONFIGURED`	`UnlinkGithubApp`, obwohl nichts verknüpft ist
400	`BRANCH_NOT_FOUND`, `INVALID_BRANCH_LENGTH`	Der Branch existiert nicht, oder sein Name ist länger als 256 Zeichen
403	`GITHUB_NOT_CONNECTED`	Dein Konto hat keine Installation der GitHub App
403	`REPOSITORY_NOT_AVAILABLE`	Die GitHub App ist über dein GitHub-Konto nicht auf dem Repository installiert
403	`REPOSITORY_PERMISSION_REQUIRED`	Dein GitHub-Konto hat keinen Schreibzugriff auf das Repository
404	`REPOSITORY_NOT_FOUND`	Das Repository existiert nicht oder ist nicht sichtbar
409	`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	Eine andere App, aus einem beliebigen Konto, verknüpft bereits dieses Repository und diesen Branch. Ihre ID steht nur dann in `Message`, wenn die App dir gehört
502	`FAILED_TO_FETCH`	GitHub hat den Branch nicht bestätigt: kann gefahrlos wiederholt werden

Aktuelle Konfiguration

Deploys.Current(ctx, appID) gibt zurück, was konfiguriert ist: App für die Verknüpfung mit der GitHub App, Webhook für die Webhook-URL. Ist nichts gesetzt, gibt die Methode den Nullwert zurück (App ist nil und Webhook ist ""). Die Felder von App sind Zeiger, da die API sie als null senden kann.

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

Deploy-Verlauf

Deploys.List(ctx, appID) gibt eine Zeitleiste pro Deploy zurück (ein [][]DeployEvent), jede ein Slice von Ereignissen, das älteste Ereignis zuerst. Nur Git-Deploys (Pushes per Webhook und GitHub App) werden aufgezeichnet.

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

Feld	Beschreibung
`ID` (`id`)	Der SHA des Commits
`State` (`state`)	`pending`, `clone`, `commit`, `restarting`, `success` oder `error` (Konstanten `DeployPending`, `DeployClone`, `DeployCommit`, `DeployRestarting`, `DeploySuccess`, `DeployError`)
`Date` (`date`)	Wann das Ereignis stattfand (`time.Time`)
`Source` (`source`)	Immer `"git"`
`Branch` (`branch`)	Bei `clone`-Ereignissen
`Files` (`files`)	Bei `commit`-Ereignissen: ein `*DeployFiles` mit `Added`, `Removed` und `Modified`; sonst `nil`
`Code` / `Message` (`code` / `message`)	Bei `error`-Ereignissen: warum der Deploy fehlgeschlagen ist (zum Beispiel `CLONE_FAILED`)

Nächste Schritte

Netzwerk

Analytics, DNS, eigene Domains und Cache.

API-Referenz für Deploys

Die REST-Endpunkte hinter diesen Methoden.

GitHub-Deploys über die CLI

Dieselben Aktionen im Terminal.

CLI

VS Code

SDKs

Webhook

GitHub App

Aktuelle Konfiguration

Deploy-Verlauf

Nächste Schritte

Netzwerk

API-Referenz für Deploys

GitHub-Deploys über die CLI

​Webhook

​GitHub App

​Aktuelle Konfiguration

​Deploy-Verlauf

​Nächste Schritte

Netzwerk

API-Referenz für Deploys

GitHub-Deploys über die CLI

Webhook

GitHub App

Aktuelle Konfiguration

Deploy-Verlauf

Nächste Schritte