デプロイ、プレビュー、ロールバック。
プッシュの本番反映、ブランチのプレビュー、以前のバージョンへの切り戻し、マイグレーション用のリリースコマンド、ビルド設定、デプロイフック、メンテナンスモード、プレビューのパスワードについて。
アプリが公開された後は、変更を反映するためにパネルを開く必要はほとんどありません。ブランチにプッシュすれば、新しいバージョンが自動で公開されます。この記事では、その周辺の機能(デプロイタブ、プレビュー、プロセスタブ、設定内のいくつかのスイッチ)をご説明します。
プッシュごとの自動デプロイ
アプリのブランチにプッシュするたびに、最新のコミットがビルドされデプロイされます。新しいバージョンは稼働中のバージョンと並行して起動し、応答できるようになってから訪問者を受け付けます。起動しなかった場合は以前のバージョンが動作し続け、メール(連携済みの場合はTelegramでも)でお知らせします。
別のビルドがキューで待機中に行われたプッシュはそのビルドにまとめられるため、プッシュが続いても長いキューにはなりません。
この機能は設定 → プッシュごとにデプロイでオフにできます。オフの場合は、パネル、API、デプロイフックからデプロイします。
パネルからのデプロイ
デプロイタブには、すべてのデプロイが一覧表示されます。きっかけ(プッシュ、パネル、ロールバック、デプロイフック)、コミット、所要時間、ステータスを確認できます。デプロイをクリックすると、ビルドログ全体が表示されます。
再デプロイには2つの選択肢があります。
- 最新のコミットをビルド:ブランチの最新コードを取得してビルドします。
- 稼働中のバージョンを再デプロイ:新しいビルドなしで、変更した変数を反映します。変数を編集した後にご利用ください。
開くの横のメニューにも同じ2つの操作と再起動があります。
ロールバック
直近5つの成功したバージョンのいずれかに戻せます。デプロイタブで戻したいバージョンのロールバックをクリックし、確認します。以前のバージョンが現在のバージョンと並行して起動し、応答できるようになった時点で切り替わります。新しいビルドは行いません。
ロールバックしても、データベースの変更は元に戻りません。リリースでデータベースの構造を変更した場合は、データベースも復元してください。詳しくはデータベースをご覧ください。
ブランチのプレビュー
その他のブランチへのプッシュには、それぞれプレビューが作成されます。公開前に変更内容を確認できる専用のアドレスです。プレビュータブから開けます。
- 同時に3つまで、料金に含まれます。
- 7日間新しいプッシュがないプレビューは削除されます。そのブランチに次にプッシュすると再作成されます。
- プレビューには、プレビュー用の変数のみが渡されます。詳しくは環境変数をご覧ください。
- プレビューはプロジェクトのメインサービスに対して作成され、その他のサービスには作成されません。
プレビューのパスワード
プレビュータブのプレビューのパスワード → パスワードを要求。ユーザー名とパスワード(8文字以上)を入力します。以降、プレビューを開けるのはパスワードを知っている人のみになります。アプリ本体は引き続き誰でも閲覧できます。
リリースコマンド(マイグレーション)
プロセスタブ → リリースコマンド。デプロイのたびに、新しいバージョンが訪問者を受け付ける前に1回実行されます。通常はデータベースのマイグレーションに使います。失敗した場合はデプロイが中止され、現在のバージョンが動作し続けるため、壊れたマイグレーションが訪問者に影響することはありません。
コマンドがあるフレームワークでは、推奨コマンドをご提案します。
| フレームワーク | 推奨リリースコマンド |
|---|---|
| Laravel | php artisan migrate --force |
| Django | python manage.py migrate --noinput |
| Prisma (Node.js) | npx prisma migrate deploy |
推奨コマンドを使用でそのまま使えます。独自のコマンドを入力するか、なしを選ぶこともできます。変更は次回のデプロイから反映されます。
ビルド設定
設定 → ビルド設定で、自動検出された内容を変更できます。
- インストールコマンド:例
npm ci - ビルドコマンド:例
npm run build - 起動コマンド:アプリを起動するコマンド。
$PORTのポートで待ち受ける必要があります。 - 出力フォルダ:静的サイトの場合、ビルド済みファイルのフォルダ。
- プロジェクトフォルダ:複数のプロジェクトを含むリポジトリの場合。
空欄にすると、自動検出された内容を使います。次回のデプロイは新しい設定でビルドされます。今すぐビルドですぐに開始できます。
デプロイするブランチも設定で指定します。
デプロイフック
設定 → デプロイフック → フックを作成。デプロイフックは非公開のアドレスで、他のサービスからここへPOSTリクエストを送ると、ブランチの最新コミットがビルドされデプロイされます。公開後にサイトを再ビルドするCMSなどでよく使われます。
curl -X POST "<パネルに表示されたフックのアドレス>"- アドレスは一度だけ表示されます。フックの作成時にコピーしてください。アドレスを知っている人は誰でもデプロイを開始できるため、外部に漏らさないでください。
- 1つのフックにつき1時間あたり10回のデプロイまで。ビルドの待機中に届いた呼び出しは、そのビルドにまとめられます。
- 無効化するとアドレスはすぐに使えなくなります。呼び出していたサービスには新しいアドレスが必要です。
メンテナンスモード
設定 → メンテナンスモード → メンテナンスページを表示。訪問者にはアプリの代わりに、メッセージを添えた簡単なページが表示されます。メッセージを空欄にすると「現在、サービスの改善作業を行っています。しばらくしてから再度アクセスしてください。」と表示されます。
アプリ自体は動作し続けるため、再公開の前にすべてを確認できます。ご自身用の非公開リンクを開くと、そのデバイスでは12時間、通常どおりアプリが表示されます。新しいリンクで新しいリンクを作成すると、古いリンクは使えなくなります。
スイッチをオフにすると、訪問者に再びアプリが公開されます。
デプロイの通知
デプロイが完了しなかった場合は、メール(連携済みの場合はTelegramでも)でお知らせします。チームにもイベント(新しいバージョンの公開、デプロイの失敗、サービスの停止・復旧、メモリやプロセッサーの高負荷、バックアップ、データベースのディスク)を送るには、設定 → チームへの通知でSlack、Discord、または独自のWebhookを追加してください。Webhookのメッセージは、一度だけ表示されるシークレットで署名されたJSONで、署名はX-Rivervo-Signatureヘッダーに入ります。