初回セットアップのチェックリスト
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
完了です オンボーディング。次に Capgo を設定します 一度だけ。その後、日常の作業は アップロード → テスト → デプロイ.
ルール: チャネルはリリースレーンです(development, production)。チケット、機能、開発者名ではありません。
初回セットアップのチェックリスト
セクションタイトル「ワンタイムセットアップチェックリスト」-
チャネルの作成: 最小限のセットを選択してください(下記参照)。
-
デフォルトの upload チャンネルを設定 における アプリ設定:
- Solo アプリ →
production - チーム →
development
- Solo アプリ →
-
Production チャンネル: public: on、device self-set: off、block updates under native: on、auto-update guard: on
major. -
Test チャンネル (
development/staging): public: off、QA 用に device self-set: on。 -
CI から upload を使用して
--delta(チェックサムとネイティブ依存関係は自動で処理されます):ターミナル npx @capgo/cli@latest bundle upload \--channel development \--bundle "1.8.0-${BUILD_NUMBER}" \--comment "commit ${GIT_SHA:0:7} run ${CI_RUN_ID}" \--deltaこの
--bundle値 必ず 有効であること セマンティックバージョニング。で検証してください。 SemVerテスター アップロードする前に。 -
本番環境にデプロイ テスト後、 ダッシュボード または CLI から。
-
チームとセキュリティ: 一度招待し、最小権限で、 2FA を組織に設定し、CIには API キーを1つ。
暗号化、 min_update_version、メタデータ、プレビューは オフ 明確な理由がない限り。
サイズを選択
セクション「サイズを選ぶ」シンプル:1つのアプリ、1つのチャネル: production
チーム: development + production。devにアップロードし、prodにデプロイ。
ネイティブバージョン:必要に応じてチャネルを追加。例: production-9.0 + test-9.0。ストアユーザーはメインの本番チャネルに留める。
多数のアプリ:アプリごとに同じシンプルなモデル(通常は1つの production 各チャネルです。組織が大きいからといって、余計なチャネルを作成しないでください。
リリーストレイン (任意): staging → rc → production。必要なアプリすべてで同じテンプレートを使用してください。
Bundle名とコメントの違い
セクション「Bundle名とコメントの違い」Bundle名は 必須です。 以下に従ってください セマンティックバージョニング。Capgo は、互換性チェック、チャンネルの自動更新ルール、ロールバックに semver を使用します。すべての名前を次で検証してください。 SemVerテスター uploadの前に。
- 名称 = CIからのsemver、例:
1.8.0,1.8.0-beta.1、または1.8.0-20260629.42 - コメント = 人間向けの自由記述 →
commit abc1234 run 28059070270
semverを使う プレリリース ラベル(〜より後の部分) -) 同じものに対して多数のビルドをリリースする場合 MAJOR.MINOR.PATCH。例えば、 1.8.0 を維持し、プレリリースに日付やビルドカウンターを追加します: 1.8.0-20260629.1, 1.8.0-beta.2。 fix-login-bug または 2.5.2026062306のような独自のフォーマットを考案しないでください。これらは有効な semver ではなく、アップロードが失敗したり、予期しない動作をしたりします。
リリースノートは --commentに記述し、バンドル名には含めないでください。
関連項目: バージョンターゲティングは、 と バンドルバージョニング.
Delta upload
セクション「Delta upload」--delta アップロード deltaファイル これにより、デバイスは毎回フルバンドルではなく変更されたファイルのみをダウンロードします。チェックサムは常に自動で計算されます。チェックサムフラグを渡す必要はありません。
デフォルト: --delta (deltaファイル + zipバックアップ)
セクション「デフォルト: --delta (deltaファイル + zipバックアップ)」npx @capgo/cli@latest bundle upload \ --channel development \ --bundle "1.8.0-${BUILD_NUMBER}" \ --deltaこれはほとんどのアプリに推奨されるデフォルト設定です。Capgo はdeltaファイルを保存し、 と フルサイズのzipをバックアップとして保持します。Deltaをサポートしていない古いプラグインバージョンのデバイスは、このzipを使用します。ストレージコストをあまり気にしない場合に適しています。
ストレージ削減: --delta-only
セクション「ストレージ削減: --delta-only」npx @capgo/cli@latest bundle upload \ --channel development \ --bundle "1.8.0-${BUILD_NUMBER}" \ --comment "commit ${GIT_SHA:0:7} run ${CI_RUN_ID}" \ --delta-only使用する --delta-only 次の場合に使用します: Capgo のストレージを削減したい場合。フルzipではなく、deltaファイルのみが保存されます。ストレージが問題になる大規模アプリや、アップロード量が多い場合に選択してください。
トレードオフ: サーバーにzipバックアップがないため、完全にdeltaファイルに依存します。Delta非対応の古いプラグインバージョンのデバイスは更新できません。 --delta-only ストレージ削減が本当に必要な場合を除き、使用しないでください。
デバイス側の追加プラグイン設定は不要です。アップデータはdeltaファイルのリストを読み取り、変更されたファイルのみを取得します。
日常のワークフロー
セクション「日常のワークフロー」Upload to development (--delta) → test → deploy to production → don't touch channel settings againよくあるミス
セクション「よくあるミス」| 間違い | 解決策 |
|---|---|
| 新しいストアリリース前にOTAを期待する | プラグイン追加後にネイティブアプリを再ビルドしてリリース |
| バンドルをアップロードしたが、チャネルにデプロイしていない | バンドルをチャネルに割り当てる(例: production) |
| 機能・チケット・開発者ごとにチャネルを分ける | 常設のリリースレーンだけを使う |
| 動的なCIチャネル名 | 固定名: development, production |
| シンプルなアプリにチャネルが多すぎる | 1〜2つのチャネルから始める |
| 本番環境でデバイスが自己設定する | 本番環境ではオフ、テストチャネルではオン |
スキップ --delta | 追加 --delta へのアップロードに使用します。代わりに --delta-only ストレージを節約する必要がある場合のみ |
| Semver 準拠でないバンドル名 | 以下に従ってください: セマンティックバージョニング で検証してください SemVerテスター |
| 時間の経過とともにバージョニング方式を変更する | Semver を維持し、追加ビルドにはプレリリースラベルを使用します(1.8.0-20260629.1) |
| 理由なくメタデータ / プレビューが有効になっている | デフォルトではオフのままにする |
| 新規インストール時の「新しいバージョンが利用可能」メッセージ | スキップする場合 current() を返します bundle.id === "builtin" (下記参照) |
App Store レビュー: 新規インストール時の更新メッセージなし
「App Store レビュー: 新規インストール時の更新メッセージなし」セクションApple は Capgo を使ったアプリは承認します。レビュアーが却下するのはその周りの UI、つまり初回起動時に表示される「新しいバージョンが利用可能」「更新中」といったメッセージです。
これは主に、アプリ自身がバージョンチェックを行って独自のプロンプトを表示するセルフホストや手動セットアップに影響します。
レビュアーはストアのバイナリをインストールします。これは最新の bundle より古いため、最初のチェックですぐに bundle が見つかります。独自のサーバー呼び出しがそれを返すか、updater がそれを見つけてイベントを発行します updateAvailable。その時点でアプリがメッセージを表示すると、レビュアーの目に留まります。
新規インストール直後やネイティブストア経由の更新直後は、アプリは同梱されたバンドルを実行し current() を返します bundle.id === "builtin"。その場合はメッセージをスキップしてください:
import { CapacitorUpdater } from '@capgo/capacitor-updater'
const { bundle } = await CapacitorUpdater.current()if (bundle.id !== 'builtin') { showNewVersionMessage()}表示されるUIでは、「update」、「live update」、「OTA」、「downloading」、「installing」という言葉は避けてください。参照: コンプライアンス.