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

Webhook

deploys.set_webhook(app_id, access_token) は、GitHub のアクセストークン (ghp_... または github_pat_...) を使って GitHub の webhook による deploy を設定し、リポジトリに追加する webhook の URL を返します。
webhook を削除するには、トークンとして "@" を渡します。その場合、メソッドは '' を返します。
無効なトークンは 400 INVALID_ACCESS_TOKEN になります。

GitHub App

deploys.link_github_app(app_id, repository, branch) は、Square Cloud GitHub App を通じてインストールされたリポジトリを連携します。apps:deploy スコープが必要です。
deploys.unlink_github_app(app_id) は連携を解除します。別のリポジトリやブランチを連携するには、先に連携を解除してください。
連携と連携解除は、60 秒あたり 3 回の制限を共有しています。

現在の設定

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

Deploy 履歴

deploys.list(app_id) は deploy ごとに 1 つのタイムラインを返します。各タイムラインはイベントのリストで、古いイベントが先頭です。記録されるのは Git による deploy (webhook と GitHub App の push) のみです。

次のステップ

ネットワーク

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

Deploy API リファレンス

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

CLI で GitHub から deploy

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