段階的なロールアウト
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
Progressive rolloutを使用すると、既存のチャネルの 安定版フォールバックを提供します 状態を維持したまま、特定の ロールアウト対象を 制御された一部のデバイスにのみ配信できます。ほとんどのプロダクションユーザーは安定版を使い続け、ロールアウト対象のグループのみが、指定するまで候補となるアップデートを受け取ります。 ロールアウトを完了 または ロールアウトをロールバック.

Progressive rollout のエンドツーエンドの仕組み
「Progressive rolloutsの仕組み(エンドツーエンド)」セクション各チャンネルでは、同時に2つのbundleリンクを持つことができます:
| コンソールラベル | API / CLI | 配信対象 |
|---|---|---|
| 安定版フォールバック | 安定版バンドル (version で Channels POST) | チャネル上のすべてのデバイスのうち、 決して ロールアウトコホートに含まれるもの。 |
| ロールアウト対象 | ロールアウト対象 (rolloutVersion / rollout_version) | ロールアウトが有効で、かつ一時停止されていない間、Capgo がロールアウト対象としてランダムに選択したデバイスのみが 対象です。 (一時停止中は除く) |
アップデート確認時のプロセス
「アップデート確認時の挙動」セクション- デバイスは、自身のチャンネルのアップデートについて Capgo に問い合わせます。
- ロールアウトが 無効である場合、またはターゲットが設定されていない場合、Capgo は 安定版フォールバックを提供します.
- ロールアウトが 対象です。 と 一時停止中、すでにコホートに含まれているデバイスは ロールアウト対象を維持します。それ以外のデバイスには 安定版フォールバックを提供します.
- ロールアウトが 対象です。 、停止せず Capgo がこのデバイスがロールアウトコホートに含まれているかを確認します:
- コホート内 → ロールアウト対象
- コホート外 → 安定したフォールバック。
Capgo は、対象となるデバイスごとにランダムな決定を行い、デバイスIDとロールアウトIDのハッシュを使用してそれをキャッシュします。これにより、コホートが 固定(sticky) されます。これにより、アップデートの確認のたびに再抽選されるのではなく、設定されたキャッシュ期間中はその状態が維持されます。
ロールアウトの有効化
「ロールアウトを有効にする」セクションロールアウトを開始するには、まず安定したフォールバックが必要です。ダッシュボードでロールアウトの対象を選択する前に、安定版のbundleを割り当ててください。 公開チャンネル API既存のチャンネルから提供できます version と rolloutVersion 同一のPOSTリクエスト内で。
配信を開始するには:
- 以下を設定してください: ロールアウト対象 (またはbundleをupload/assign — {@link ...} を参照) bundle のアップロードと割り当て).
- 以下の パーセンテージを をクリックし、 パーセンテージを適用.
- クリック ロールアウトを有効化.
ロールアウトを有効にするまで、ターゲットやパーセンテージを設定しても、配信されるデバイスには影響しません。
パーセンテージの変更
「パーセンテージの変更」セクションコンソールでパーセンテージを編集し、 適用する割合 をクリックして保存します。Capgo は、可能な限り既存の決定を維持します:
- パーセンテージを増やす場合 — すでに選択されているデバイスはそのまま維持され、未選択のデバイスからランダムにサブセットが追加されます。
- パーセンテージを減らす場合 — 選択されているコホートからランダムにサブセットが選ばれ、安定したフォールバックに戻ります。
- パーセンテージを 0% に設定する — 新しいデバイスは選択されません。有効なロールアウト対象を実行中のデバイスは、無効化、ロールバック、または対象の変更を行うまで、引き続きその対象を受け取ります。
- ロールアウトを一時停止 — 新しいデバイスの参加を停止しますが、有効な対象を実行中のデバイスはそのまま残ります。
- ロールアウトを無効化 — ロールアウト対象の解決を停止します。アップデートチェックは安定版のフォールバックを使用します。
bundle のアップロードと割り当て
セクション「bundleのアップロードと割り当て」チャンネルでは を使用して progressive rolloutが設定されている場合、新しいアップロードとbundleリンクは次に送られます: ロールアウト対象 デフォルトで。 安定版フォールバック 明示的に置き換えを選択しない限り、変更されません。
デフォルトのアップロードルーティング
「Default upload routing」セクション| Channelの状態 | デフォルトのアップロード / 割り当て | 安定版フォールバック | ロールアウト対象 |
|---|---|---|---|
| いいえ progressiveロールアウトが設定済み | チャンネルに到達 | アップロード先に設定 | 該当なし |
| Progressive rolloutの設定完了 | チャンネルに到達 | 変更なし | アップロード先に設定 |
CLI と API のパス
「CLI と API のパス」セクション| bundle の配信方法 | 安定版フォールバック | ロールアウト対象 | 備考 |
|---|---|---|---|
bundle upload --channel <name> (追加フラグなし) | ロールアウトチャネルでは変更なし; 設定 ロールアウトなしの場合 | 設定 ロールアウトチャネルでは | コンソールのデフォルト設定と一致します。 |
bundle upload --channel <name> --rollout <percent> | 変更なし | 設定; ロールアウト 対象です。 そのパーセンテージで | アップロードして有効化するだけ。 |
bundle upload --channel <name> --stable | 置換済み | 変更なし | エスケープハッチ — 意図的に安定版へ置き換える手段。 |
bundle upload を使用して いいえ --channel | 変更なし | 変更なし | 登録のみ。以下と連携: channel set または API。 |
| コンソールのリンクダイアログ → Auto(推奨) | ロールアウトチャネルを変更しない | 設定 ロールアウトチャネルでは | デフォルト設定。 |
| コンソールのリンクダイアログ → ロールアウト対象 | 変更なし | 設定 | 明示的なロールアウト対象 |
| コンソールのリンクダイアログ → Stable を置き換え | 置換済み | 変更なし | エスケープハッチ |
PUT /bundle/ を使用して target: "auto" | ロールアウトチャネルでは変更なし | 設定 ロールアウトチャネルでは | API のデフォルト。 |
PUT /bundle/ を使用して target: "rollout" | 変更なし | 設定 | 明示的なロールアウト対象 |
PUT /bundle/ を使用して target: "stable" | 置換済み | 変更なし | エスケープハッチ |
channel set --bundle <version> | 置換済み | 変更なし | 明示的な安定版オーバーライド |
channel set --rollout-bundle <version> (+ --rollout-percentage, --rollout-enable) | 変更なし | 設定済みまたは変更済み | アップロードせずにターゲットを設定。 |
Channels POST version | 置換済み 設定時 | 変更なし | 明示的な安定版オーバーライド |
Channels POST rolloutVersion | 変更なし | 設定済みまたは変更済み 設定時 | プログラムによるターゲット割り当て。 |
CLI の例
「CLI の例」セクションロールアウト設定済みのチャンネルへのデフォルトのアップロード(ロールアウト対象を指定、stable は変更なし):
bunx @capgo/cli@latest bundle upload com.example.app \ --path ./dist \ --channel productionアップロード、ロールアウト対象の設定、および 5% での有効化:
bunx @capgo/cli@latest bundle upload com.example.app \ --path ./dist \ --channel production \ --rollout 5stable を明示的に置き換える:
bunx @capgo/cli@latest bundle upload com.example.app \ --path ./dist \ --channel production \ --stableリンクせずにアップロードし、その後ロールアウトを設定する:
bunx @capgo/cli@latest bundle upload com.example.app --path ./dist -b 1.3.0
bunx @capgo/cli@latest channel set production com.example.app \ --rollout-bundle 1.3.0 \ --rollout-percentage 5 \ --rollout-enable明示的なターゲットを指定して API を割り当て (auto | stable | rollout):
curl -X PUT \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "app_id": "com.example.app", "version_id": 456, "channel_id": 789, "target": "rollout" }' \ https://api.capgo.app/bundle/選択済みのデバイスを維持したまま、公開範囲を拡大します:
bunx @capgo/cli@latest channel set production com.example.app \ --rollout-percentage 25使用する --rollout-percentage-bps パーセント単位よりも細かいステップが必要な場合(例: 50 = 0.5%).
詳細については、 channel CLI リファレンス と CLI bundleのリファレンス 各ロールアウトオプションについて。コンソールのUXは capgo.app#3313 に実装されています.
Progressive rollout セクション(dashboard)
「Progressive rollout section (dashboard)」セクションアプリを開く → チャンネル → チャネルを選択 → 情報 → 段階的ロールアウト.
セクションの表示内容: ロールアウト対象 と 安定版フォールバック 2つのbundleリンクに対して使用します。 ロールアウト対象を変更 から別の候補bundleを選択します。パーセンテージを編集した後、 パーセンテージを適用 をクリックして保存します。
| コントロール | 仕組み | すでにコホートに含まれているデバイス | 新しく対象となったデバイス |
|---|---|---|---|
| ロールアウト対象を変更 | 設定します rolloutVersion. これを変更すると、新しいロールアウトIDと新しいコホートが開始されます。チャンネル(デフォルト)へのbundleのアップロードや割り当てを行う際にも、ロールアウトのターゲットが設定されます。 | ユーザーが再度チェックインし、新しい決定ルールに一致するまで、以前のターゲットを維持します。 | 新しいターゲットに対するパーセンテージに基づいて選択されます。 |
| パーセンテージを適用 | 入力したパーセンテージを保存します。 | 値を増やした場合は維持されますが、減らした場合はランダムなサブセットが除外される可能性があります。 | 上記のパーセンテージルールに従って、追加または除外されます。 |
| ロールアウトを有効化 | 設定されたターゲットとパーセンテージでロールアウト配信を有効にします。 | 次回のアップデートチェックまで、即座には変更されません。 | 次回のチェック時に選択される可能性があります。 |
| ロールアウトを一時停止 | 新規デバイスの流入を停止します。 | ロールアウト対象を維持します。 | 安定したフォールバックを受信します。 次回のチェック時に。 |
| ロールアウトを再開 | 一時停止を解除します。 | 変更なし。 | 次回のチェック時に再度選択される可能性があります。 |
| ロールアウトを無効化 | ロールアウト対象の解決を停止し、Capgo は全員に安定したフォールバックを使用します。 | 安定したフォールバックへ移行 次回のチェック時に。 | 安定版フォールバックを受け取る。 |
ロールアウトを完了 (API: promoteToStable; CLI: --rollout-promote) | ロールアウト対象を新しい安定版のフォールバックに設定し、ロールアウト状態をクリアします。確認済み: プログレッシブ・ロールアウトを完了しますか? — 対象が全員に対して安定版となり、以前の安定版フォールバックが置き換わり、パーセンテージがリセットされます。 | 安定版フォールバックにする 全員に対して。 | 完了したバンドルを 安定版として受け取る。 |
ロールアウトをロールバック (API: rollback; CLI: --rollout-rollback) | ターゲットをクリアし、ロールアウトを無効化、パーセンテージを0%にリセットして、デバイスを安定版フォールバックに戻します。 | 安定版フォールバックに戻す 次回のチェック時に。 | 安定版フォールバックを受け取る。 |
終了アクションは一度に1つだけ使用してください(ロールアウトを完了 と ロールアウトをロールバック 1回の API 呼び出しでは組み合わせられません):
# Stop adding devices while you investigatebunx @capgo/cli@latest channel set production com.example.app --rollout-pause
# Allow new devices to enter againbunx @capgo/cli@latest channel set production com.example.app --rollout-resume
# Complete rollout — candidate becomes stable for everyonebunx @capgo/cli@latest channel set production com.example.app --rollout-promote
# Rollback rollout — discard candidate and return to stablebunx @capgo/cli@latest channel set production com.example.app --rollout-rollbackロールアウト対象のbundleを、以下の操作を行うまで保持してください: ロールアウトを完了 または ロールアウトをロールバックstable fallbackとしてリンクされている、またはロールアウト対象のbundleは削除から保護されます。
安全なワークフロー
「Safe workflow」セクションProgressive rolloutは、チャンネル全体を一気に切り替えることなく、本番環境で検証できるように設計されています。推奨される手順は以下の通りです:
- stable fallbackが正常であることを確認します。 これは、ほとんどのユーザーに継続して配信したいバージョンである必要があります。
- 候補となるbundleをupload rollout設定済みのchannelへ(
bundle upload --channel <name>に到達し、 ロールアウト対象 から離脱する 安定版フォールバック のみの挙動)または、--rollout <small-percent>を使用して、同一ステップで公開を開始します。 - スモールスタートで — 初期のシグナル確認には1–5%で十分です。 パーセンテージを適用、次に ロールアウトを有効化. 失敗率が急増したときに Capgo の公開を止めたい場合は、auto-pause をオンにしてください。
- 展開範囲を広げる前にモニタリングしましょう。 使用する Observe でバージョンの健全性と ログ分析 エラーパターンを確認し、チャンネルの 履歴 タブで設定変更を確認してください。ロールアウト対象と安定版フォールバックを比較し、コホートが健全に見えるまでパーセンテージを上げないでください。
- 段階的に増やす — パーセンテージを編集し、クリック パーセンテージの適用, および段階的な引き上げ(例: 5% → 25% → 50% → 100%)。Capgo を使用すると、引き上げ時にすでにそのコホートに含まれているデバイスは維持されます。
- 確信が持てたらロールアウトを完了する — 確認 プログレッシブ・ロールアウトを完了しますか? これにより、対象の候補が全員にとっての安定したフォールバックになります。
- 問題が発生した場合は、まずロールアウトを一時停止してください — これにより、調査中の新規露出を停止できます。問題のあるビルドが適用済みのデバイスは、以下の操作を行うまでその状態が維持されます。 ロールアウトをロールバック または ロールアウトを無効化.
自動一時停止ポリシー
「Auto-pause ポリシー」セクションCapgo は、有効なロールアウトを5分ごとに評価し、失敗シグナルが設定した閾値を超えた時点でアクションを実行できます。選択したチャンネルと時間枠でロールアウト対象のインストール数と失敗数を計測し、単純な失敗率ではなく Wilson 信頼区間の下限を使って判断します。
Auto-pause はデフォルトで無効です。チャンネルの以下のフィールドで設定します。 情報 タブまたは channel set:
- 失敗率のしきい値 ベーシスポイント(
500= 5%)。ポリシーをトリガーするにはしきい値が必要です。 - ウィンドウ 分単位(デフォルト: 60)。
- 信頼度 の間
0と1(デフォルト:0.95). - 任意の最小試行回数と失敗回数(サンプルが少なすぎる場合の誤作動を防ぐため)。
- クールダウン 分(デフォルト: 60)で、同じアクションの繰り返しを防ぎます。
- アクション:
pause,rollback、またはnotify.
pause 新しいロールアウトの公開を停止し、 rollback ターゲットをクリアして安定したフォールバックに戻し、 notify ロールアウトの配信を変えずに、ロールアウトのアラートを送信します。
bunx @capgo/cli@latest channel set production com.example.app \ --auto-pause-enabled \ --auto-pause-failure-rate-bps 500 \ --auto-pause-window-minutes 60 \ --auto-pause-confidence 0.95 \ --auto-pause-min-attempts 100 \ --auto-pause-min-failures 5 \ --auto-pause-action pause \ --auto-pause-cooldown-minutes 120API と dashboard へのエントリーポイント
セクション「API とダッシュボードのエントリポイント」- ダッシュボード: アプリ → チャンネル → channel → 情報 → 段階的ロールアウト
- API のチャンネル: 公開チャンネル API ロールアウトのフィールド、プロモート、ロールバック用
- API の Bundle 割り当て: PUT
/bundle/を使用してtarget:auto,stable、またはrollout
一般的なチャンネルルーティングとデバイスの優先順位については、こちらを参照 チャンネル. プログレッシブロールアウト以外で緊急にbundleを復旧する場合は、以下を参照してください: live update のロールバック.