Orbit内のブランチプレビューデプロイメント

Branch previews build every non-production, non-staging branch you push to its own isolated URL, so you can click through a change in a real environment before it merges. This guide covers turning…

ブランチプレビューの有効化

Orbit でプロジェクトを開く
Settings タブを開く
Runtime セクションを探して、Branch previews をオンにする

有効化すると、本番ブランチでもステージングブランチでもないブランチへのプッシュのたびに、ビルドがトリガーされ、独自のプレビュー環境にデプロイされます。

Orbit プロジェクト設定のブランチプレビュー切り替え

ブランチプレビューはプロジェクトごとの切り替えであり、有料のアドオンではありません。無料の Launch プランを含む、すべての Orbit プランで利用可能です。プランによって異なるのは、単一プロジェクトが同時に持つことができる環境の数です。Launch は 2 つ (本番とプレビュー 1 つ)、Liftoff は 4 つ、Apex は 11 つです。プロジェクトが環境の上限に達した場合、さらなるブランチは 1 つが削除されるまで独自のプレビューを取得できません。

プレビューURL

プレビューは、ブランチ名に由来するホスト名を取得します。名前は小文字に変換され、文字、数字、またはハイフンではないすべての文字がハイフンになり、ハイフンの連続が折りたたまれ、結果は 48 文字に短縮され、branch- で始まります。

ブランチ	プレビューホスト名
`redesign`	`branch-redesign.kaps.run`
`feat/new-checkout`	`branch-feat-new-checkout.kaps.run`
`JB/Fix_Cart`	`branch-jb-fix-cart.kaps.run`

プレビュー URL は、リンクを持つすべてのユーザーによってパブリックにアクセス可能です。インデックス付けや宣伝はされていませんが、アクセス制御もされていません。チームを離れてはいけないものをレビューするためにプレビューを使用しないでください。また、プレビューを本番データポイントしないでください。保護されたプリプロダクション環境が必要な場合は、代わりに staging 環境を使用してください。ステージングは Settings の下にある Staging: access protection および Staging: IP allowlist セクションでパスワードと IP アローリストをサポートしています。

プレビューが表示される場所

プロジェクトの Overview タブには、すべてのアクティブなプレビューをリストアップする Preview deployments セクションがあります。各行は以下を表示します。

ブランチ名、およびブランチにプルリクエストが開いている場合はそのプルリクエストにリンクする PR #number バッジ
現在のステータス (QUEUED、BUILDING、またはライブ)
デプロイされてからの経過時間
プレビュー URL を開くためのリンク
View logs でデプロイメント詳細ページを開く
削除ボタン

各プレビューは、独自の URL、独自のビルド、独自の環境変数を備えた完全に分離された環境です。これが行うことは本番環境に影響を与えることはできません。

プロジェクトの Branches タブは、同じ情報をブランチごとに整理して表示するため、同時に複数開いているときのスキャンが容易になります。

プレビューの環境変数

これは正しく理解する価値のある部分です。All environments (project-wide) にスコープされた変数はプレビュービルドに注入され、プレビュー URL はパブリックです。

本番認証情報は本番環境のみにスコープして保存してください。
サードパーティサービス用にテストモードまたはサンドボックス認証情報をプレビューに提供してください。
本番データベース URL またはライブ支払いキーをプロジェクト全体のスコープに放置しないでください。

完全なメカニクス (本番のみの変数を追加する方法やステージングの継承がどのように機能するかを含む) は、環境ごとに環境変数を設定に記載されています。

プレビューのビルドログ

プレビューの横の View logs をクリックして、デプロイメント詳細ページを開きます。プレビューは本番デプロイメントと同じように扱われます。完全なストリーミングビルドログ、ビルドフェーズ、コミットと作者、アーティファクトサイズ、キャッシュヒットまたはコールドビルド、検出されたフレームワークとパッケージマネージャー、およびビルドが失敗したときの AI 診断ボタン。

プレビューの削除

プレビュー行の削除ボタンをクリックして確認します。

プレビューを削除すると、現在のデプロイメントだけでなく、環境全体とそのビルド履歴全体が削除されます。元に戻すことはできません。ブランチ自体は変更されないため、再度プッシュすると、履歴なしで最初から新しいプレビューが作成され、コールドビルドキャッシュになります。

自動クリーンアップ

自分の後片付けをする必要はありません。

プルリクエストが閉じられるか、マージされた場合、そのプレビュー環境は直ちに一時停止され、提供が停止されます。訪問者は古いビルドではなく 404 を取得します。
ブランチを削除すると、そのブランチのプレビューが同じ方法で一時停止されます。
一時停止されたプレビューは約 1 日後にガベージコレクションされます。ソース tarball、ビルドアーティファクト、ビルドキャッシュが削除され、環境がアーカイブされます。

また、スケジュールでプレビューを有効期限切れにすることもできます。Settings で Preview expiry を探し、Never、7、14、30、または 60 日を選択します。それより古いプレビューは自動的に一時停止され、24 時間以内にクリーンアップされます。

ビジーなリポジトリでは、Preview expiry を 14 日または 30 日に設定します。すべてのアクティブなプレビューはプロジェクトの環境制限にカウントされ、期限切れのプレビューは新しいブランチが静かにプレビューを取得できなくなる通常の理由です。

承認とプレビュー

Deploy protection の下で Require approval for production が有効になっている場合、それは本番のみに適用されます。プレビュービルドは承認のために保持されません。

削除することなく特定のプレビューがさらなる変更をデプロイするのを停止するには、Environments タブから環境を一時停止します。一時停止された環境への新しいデプロイは、再開するまでスキップされます。

トラブルシューティング

ブランチがプッシュされたがプレビューが表示されない。 順番に確認してください。Settings の Runtime で Branch previews がオンですか。ブランチは実際にステージングブランチですか (ステージングはプレビューではなくステージングにデプロイします)。ブランチは Branch ignore patterns のいずれかと一致していますか。例えば dependabot/*。プロジェクトは既にあなたのプランの環境制限に達していますか。

プレビューはビルドされましたが、404 が表示されます。 ビルドは成功しましたが、このブランチの出力ディレクトリが間違っている可能性があります。Settings で Output directory を確認し、ブランチが設定を変更することなく出力を変更できることを覚えておいてください。ビルドコマンドと出力ディレクトリの設定を参照してください。

プレビューは古いコミットを表示しています。 同じブランチのビルドがまだ実行中に新しいコミットをプッシュすると、進行中のビルドがキャンセルされ、新しいビルドが開始されます。キャンセルされたデプロイメントに続いて実行中のデプロイメントが表示される場合、それは予期されたことです。2 番目のビルドを待ちます。

クローズされた PR のプレビューはまだアクセス可能です。 一時停止は webhook イベントで行われます。PR をクローズしたときにプロバイダー接続が切断された場合、イベントは到達しませんでした。Overview タブからプレビューを手動で削除します。