デプロイ
deployments カテゴリの API 操作 3 件をカバーします。
| メソッド | パス | 説明 |
|---|---|---|
| GET | /v1/orgs/{orgSlug}/projects/{projectName}/deployments | デプロイ履歴 |
| POST | /v1/orgs/{orgSlug}/projects/{projectName}/deployments | アーティファクトをアップロードした後にデプロイします |
| POST | /v1/orgs/{orgSlug}/projects/{projectName}/rollback | 以前のバージョンにロールバックします |
GET /v1/orgs/{orgSlug}/projects/{projectName}/deployments
最新バージョンが先頭に来ます。アーティファクトはイミュータブルで、削除されることはありません。
operationId listDeployments
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 200 | デプロイの一覧 | object |
| 403 | — | — |
| 404 | — | — |
POST /v1/orgs/{orgSlug}/projects/{projectName}/deployments
本文はバンドルの tarball そのものです。バンドルは自己記述的であるため、メタデータは別途受け取りません — マニフェストはバンドルの内部にあるので、1 つのダイジェストでコード・アセット・設定をまとめてカバーできます。別フィールドとして受け取ると、ダイジェストの対象外となる入力が生まれてしまいます。
バンドルのレイアウト(gzip 圧縮された tar):
runlot.json マニフェスト(必須) worker/ worker のコード。静的サイトの場合は省略可能 assets/ 静的アセット。省略可能
同じダイジェストを再度アップロードしても新しいバージョンが作成されます — デプロイとは「このコードをアップロードする」ことではなく「今すぐこれを配信する」というイベントであり、ロールバック履歴を読みやすく保つには、こうしたイベントの1つ1つが独立して残る必要があります。
アップロードが成功すると、新しいデプロイは直ちに公開されます。
Provenance ヘッダー(任意)。本文がバンドルそのものであるため、メタデータはヘッダーとして届きます。CLI はデプロイするフォルダの git を読み取って含めますが、git がない場合は省略します。CP はこれらを検証できないため表示専用であり、認可や配置の根拠にはなりません。
X-Runlot-Git-Commit HEAD のハッシュ(hex、7〜64 文字) X-Runlot-Git-Message コミットメッセージの最初の行、パーセントエンコード済み(200 文字で切り詰め) X-Runlot-Git-Branch ブランチ名、パーセントエンコード済み X-Runlot-Git-Dirty true|false — コミットされていない変更があったかどうか
operationId createDeployment
| パラメーター | 場所 | 必須 | 型 | 説明 |
|---|---|---|---|---|
X-Runlot-Git-Commit | ヘッダー | 不可 | string | — |
X-Runlot-Git-Message | ヘッダー | 不可 | string | — |
X-Runlot-Git-Branch | ヘッダー | 不可 | string | — |
X-Runlot-Git-Dirty | ヘッダー | 不可 | boolean | — |
リクエストボディ: application/gzip · string
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 201 | 作成されたデプロイ | Deployment |
| 400 | — | — |
| 403 | — | — |
| 404 | — | — |
| 413 | バンドルが上限を超えています | Error |
POST /v1/orgs/{orgSlug}/projects/{projectName}/rollback
新しいデプロイを作成せずに project_live を以前のデプロイに移動します。アーティファクトはイミュータブルなので、ロールバック後の結果は当時配信されていたのとまったく同じバイト列になります。
operationId rollback
リクエストボディ: application/json ・ object
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 200 | ロールバック後のデプロイ | Deployment |
| 403 | — | — |
| 404 | — | — |