JavaScript SDK: GitHub からの deploy

api.apps.deploys はアプリを GitHub に接続し、push するだけで deploy されるようにします。方法は 2 つあります。リポジトリに追加する webhook か、Square Cloud GitHub App です。サンプルでは、クライアントの作成で作成した api クライアントを使います。appId はあなたのアプリの ID で、api.account.me() で一覧できます。

Webhook

deploys.setWebhook(appId, accessToken) は、GitHub アクセストークン (ghp_... または github_pat_...) を使って GitHub webhook による deploy を設定し、リポジトリに追加する webhook URL を返します。

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

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

webhook を削除するには、トークンとして "@" を渡します。その場合、メソッドは "" を返します。

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

無効なトークンは 400 INVALID_ACCESS_TOKEN になります。

GitHub App

deploys.linkGithubApp(appId, repository, branch) は、Square Cloud GitHub App を通じてインストールされたリポジトリを連携します。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) は連携を解除します。別のリポジトリやブランチを連携するには、先に連携を解除してください。

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

連携と連携解除は、60 秒あたり 3 回の制限を共有しています。

ステータス	コード	発生条件
400	`GIT_ALREADY_CONFIGURED`	アプリにすでにリポジトリが連携されている: 先に連携を解除してください
400	`GIT_NOT_CONFIGURED`	何も連携されていない状態での `unlinkGithubApp`
400	`BRANCH_NOT_FOUND`, `INVALID_BRANCH_LENGTH`	ブランチが存在しない、またはブランチ名が 256 文字を超えている
403	`GITHUB_NOT_CONNECTED`	あなたのアカウントに GitHub App のインストールがない
403	`REPOSITORY_NOT_AVAILABLE`	あなたの GitHub アカウント経由で、そのリポジトリに GitHub App がインストールされていない
403	`REPOSITORY_PERMISSION_REQUIRED`	あなたの GitHub アカウントにリポジトリへの書き込み権限がない
404	`REPOSITORY_NOT_FOUND`	リポジトリが存在しない、または表示できない
409	`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	いずれかのアカウントの別のアプリが、すでにこのリポジトリとブランチを連携している。そのアプリがあなたのものである場合に限り、`message` にその ID が含まれます
502	`FAILED_TO_FETCH`	GitHub がブランチを確認できなかった: リトライしても安全です

現在の設定

deploys.current(appId) は設定内容を返します。app は GitHub App の連携、webhook は webhook URL です。何も設定されていない場合は {} を返します。

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

Deploy 履歴

deploys.list(appId) は deploy ごとに 1 つのタイムラインを返します。各タイムラインはイベントの配列で、古いイベントから順に並びます。記録されるのは Git による deploy (webhook と GitHub App への push) のみです。

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

フィールド	説明
`id`	commit の SHA
`state`	`pending`、`clone`、`commit`、`restarting`、`success`、`error` のいずれか
`date`	イベントが発生した日時
`source`	常に `"git"`
`branch`	`clone` イベントに含まれる
`files`	`commit` イベントに含まれる: `{ added, removed, modified }`
`code` / `message`	`error` イベントに含まれる: deploy が失敗した理由 (例: `CLONE_FAILED`)

次のステップ

ネットワーク

アナリティクス、DNS、カスタムドメイン、キャッシュ。

Deploy API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI で GitHub から deploy

同じ操作をターミナルから行います。

CLI

VS Code

SDKs

JavaScript SDK: GitHub からの deploy

Webhook

GitHub App

現在の設定

Deploy 履歴

次のステップ

ネットワーク

Deploy API リファレンス

CLI で GitHub から deploy

​Webhook

​GitHub App

​現在の設定

​Deploy 履歴

​次のステップ

ネットワーク

Deploy API リファレンス

CLI で GitHub から deploy

Webhook

GitHub App

現在の設定

Deploy 履歴

次のステップ