メインコンテンツへスキップ
PRプレビュー

すべてのプルリクエストを実機でレビュー

CIが各プルリクエストのWebビルドをそれぞれ専用のCapgoチャンネルにアップロードします。レビュアーはQR code をスキャンするか、アプリ内でチャンネルを切り替えて実機で試せます。PRがクローズされるとチャンネルは削除されます。ネイティブ側のcodeの変更には、引き続き新しいビルドが必要です。

  • プルリクエストごとに1チャンネル
  • QR code プレビュー
  • PRクローズ時にクリーンアップ

課題

Webの変更をレビューするのに、新しいバイナリは不要なはずです

ストアのテスト用ビルドでPRをレビューする

  1. 開発者がPRを作成

    変更はレビュー可能な状態ですが、まだ実機で試すことができません。

  2. ビルド、署名、アップロード

    誰かがブランチ用のネイティブバイナリをビルドして署名し、TestFlightやPlayのテストトラックにアップロードして、処理完了を待ちます。

  3. 招待とインストール

    レビュアーをテスターとして追加し、そのビルドそのものをインストールしてもらう必要があります。

  4. 修正のたびに繰り返し

    code を変更するレビューコメントごとに、ビルド、アップロード、インストールがもう1回必要になります。

JavaScriptしか変わっていなくても、レビューのたびにネイティブビルドを待つことになります。

チームにかかるコスト

すべてのbuild

ストアの処理待ち

TestFlightやPlayのテストトラックにアップロードしたbuildは、テスターがインストールできるようになる前に処理されます。これはすべてのbuildで発生します。

すべてのPR

テストには専用のネイティブビルドが必要

Live Updatesがない場合、Webのみの変更でも、誰かが新しいバイナリをbuild・署名・アップロードするまでレビュアーはブランチを試せません。

フィードバックの遅れ

レビューは作成者が別の作業に移った後

レビューがbuild待ちになると、フィードバックは遅れて届き、作成者は別のタスクに移り、ブランチはmainから乖離します。

仕組み

チームがCapgoでPRをプレビューする方法

4つのCIステップ:スコープ付きキーを一度設定、pushごとにアップロード、プレビューを共有、クローズ時にクリーンアップ。以下のコマンドはすべてCapgoのドキュメントからです。

  1. App Previewキーを作成してプレビューを有効化する

    管理者がCI用にApp Preview API キーを作成します。このキーはプレビューチャネルを作成し、bundleをアップロードできますが、デフォルトまたは本番チャネルは変更できません。プレビューの有効化はアプリごとに1回だけです。

    # once, run by an admin (not the preview key)
    npx @capgo/cli@latest app set com.example.app --preview
    App Preview API キー
  2. PRビルドを専用チャネルにアップロードする

    pushのたびに、CIがWebアプリをビルドし、一意のbundleバージョンでアップロードします。bundle upload --channel は、pr-<number> チャネルが存在しなければ作成し、bundleを紐付けます。

    npx @capgo/cli@latest bundle upload com.example.app \
      --apikey "$CAPGO_PREVIEW_KEY" \
      --path ./dist \
      --channel "pr-$PR_NUMBER" \
      --bundle "1.2.3-pr.$PR_NUMBER.$GITHUB_RUN_NUMBER"
    チャネルドキュメントのPRプレビュー
  3. PRにプレビューを投稿する

    get-qrはチャネル用のQR code、または --url を付けるとプレビューURLを出力するので、CIがPRコメントに追加できます。

    npx @capgo/cli@latest get-qr com.example.app \
      --channel "pr-$PR_NUMBER" \
      --apikey "$CAPGO_PREVIEW_KEY" \
      --url
    get-qrのリファレンス
  4. PRクローズ時にチャネルを削除する

    プルリクエストのクローズイベントでこれを実行します。App Preview キーを使えば、そのキーが作成したチャネルと、それに紐付けられたbundleだけを削除します。

    npx @capgo/cli@latest channel delete \
      "pr-$PR_NUMBER" com.example.app \
      --apikey "$CAPGO_PREVIEW_KEY" \
      --delete-bundle \
      --success-if-not-found
    channel CLI リファレンス

レビュアーが PR チャネルに切り替える他の方法

どちらもセルフアサインを許可するチャネルが必要です。App Preview キーではこれが設定されないため、そのキーを使う場合は QR プレビューを共有するか、コンソールでデバイスオーバーライドを設定してください。

シェイクメニュー

内部ビルドでシェイクメニューをオンにします。テスターがデバイスを振ると Capgo のテストメニューが開き、シェイクのチャンネルセレクターからチャンネルを選べます。

// capacitor.config.ts (internal builds)
CapacitorUpdater: {
  shakeMenu: true,
}

アプリ内スイッチャー

開発者設定画面にチャンネルフィールドを追加し、PRのチャンネル名を指定して setChannel() を呼び出します。

import { CapacitorUpdater } from '@capgo/capacitor-updater'

await CapacitorUpdater.setChannel({
  channel: 'pr-123',
  triggerAutoUpdate: true,
})
setChannel() リファレンス

PRプレビューを使うのは誰か

プルリクエストをレビューする人なら、作成者だけでなくスマホで確認できます。

QAエンジニア

  • PRのWebビルドを自分のデバイスでテストする
  • アプリを再インストールせずにPRチャンネルを切り替える
  • チャンネル名がPR番号と一致するので、どの code を実行しているかが分かります

プロジェクトマネージャー

  • マージ前にスマホで新機能を試す
  • PRに投稿されたQR code をスキャンする
  • PR上で直接フィードバックを残す

開発者

  • PRがオープンなうちに実機からフィードバックを得る
  • プッシュするたびにPRチャンネルが更新される
  • JSのみの変更ならNative Buildは不要

ストアのテストビルド vs Capgo PRチャンネル

  • PRを実機で確認するまで

    TestFlight / Playでのテスト
    Native Build、署名、ストアの処理
    Capgo PRチャンネル
    WebビルドとCIからのbundleアップロード
  • PR間の切り替え

    TestFlight / Playでのテスト
    別のビルドをインストール
    Capgo PRチャンネル
    別のQR code をスキャンするか、チャンネルを切り替え
  • レビュアーのセットアップ

    TestFlight / Playでのテスト
    テスターを招待し、各ビルドをインストール
    Capgo PRチャンネル
    アプリを一度インストール
  • Native code とプラグインの変更

    TestFlight / Playでのテスト
    はい
    Capgo PRチャンネル
    いいえ、ネイティブビルドが必要です

Capacitor で構築されたアプリ

プロダクトアプリには、レビュー可能なモバイル変更が必要です

学習、イベント、コミュニティアプリでは、オンボーディング、練習、ライブセッション、サブスクリプションの変更を同時にレビューできます。PRプレビューを使えば、マージ前にプロダクト、QA、サポートがモバイル対応ビルドを確認できます。

StudySmarter - 学校・大学向けアプリのアイコン 教育

StudySmarter - 学校・大学向け

レッスン、コース、サブスクリプションの変更にステークホルダーの確認が必要な教育アプリ。

Google Play インストール数
650万
ストア評価
4.8
Poll Everywhereのアプリアイコン ビジネス

Poll Everywhere

マージ前にイベントフローのテストが必要な、ライブエンゲージメントアプリ。

Google Play インストール数
110万
ストア評価
3.2
lichess • 無料のオンラインチェスアプリのアイコン ゲームボード

lichess • 無料のオンラインチェス

トーナメントや解析画面のデバイスプレビューが役立つコミュニティアプリ。

Google Play インストール数
1130万
ストア評価
4.3

導入実績

Capgo を活用するチームの声

5.0/5 開発チームによる評価 9,400+ チーム数 レビューを読む

ネイト・ファン・ヨレ

CTO, プライベート

「セットアップは1日もかかりませんでした。チャンネルベースのロールアウトのおかげで、本番ユーザーに配信する前に自分のデバイスでテストできます。」

Michael Haberlerのポートレート

Michael Haberler

主要指標

&ldquo;Updater pluginは素晴らしい出来です。完璧に動作していますし、Live Updatesはテストのサイクルを劇的に速めてくれます。&rdquo;

no-tone @ Webincode

Webincode 開発者

「Device IDを特定のグループに追加して、そのグループにだけ変更をプッシュできるのは本当に助かります。」

よくある質問

PRプレビューについてチームがよくする質問

CIをセットアップする人とレビュアーのための、明快な回答です。

レビュアーはPRごとに新しいビルドが必要ですか?

PRがWebレイヤーだけを変更する場合は不要です。レビュアーはアプリを一度インストールするだけで、各PRのJavaScript、HTML、CSS、アセットはそれぞれ専用のチャンネルに配信されます。PRでプラグインを追加したり、ネイティブのcodeを変更したりする場合はネイティブビルドが必要です。CIで build needed を実行すれば検出できます。

Native Build が必要なケース

CIキーは本番チャンネルに影響しますか?

App Preview の API キーなら影響しません。プレビューチャンネルの作成、バンドルのアップロード、そして自分が作成したチャンネルとバンドルの削除だけが可能です。デフォルトやメインのチャンネルは変更できません。GitHub Actions では、ジョブを pull_request_target ではなく pull_request で実行し、同じリポジトリからのPRに限定してください。

App Preview API キー

レビュアーはプレビューをどうやって開きますか?

管理者が一度 app set --preview でプレビューを有効にします。あとは get-qr がPRチャンネル用のQR code を出力し、--url がWebプレビューのURLとディープリンクを出力します。それをPRのコメントに貼ってください。

get-qrのリファレンス

古いPRのチャンネルとバンドルはどうなりますか?

pull request closed イベントで channel delete を --delete-bundle と --success-if-not-found 付きで実行するジョブを追加します。App Preview キーなら、これでチャンネルとそれに紐づくバンドルが削除されます。以前のpushで作られたバンドルは、削除権限のあるキーで bundle cleanup を使って削除できます。

channel CLI リファレンス

GitLab、Bitbucket、Azure DevOpsでも利用できますか?

はい。手順は Capgo CLI コマンドなので、どのCIでも動作します。ドキュメントには、GitHub Actions、GitLab CI、Bitbucket Pipelines、Azure DevOps向けの統合ガイドがあります。

CI/CD 連携

次のプルリクエストをスマホでプレビュー

CIにアップロード、QR、クリーンアップのステップを追加して、無料トライアル中に自分のアプリで試してみましょう。

14日間の無料トライアル、クレジットカード不要。ネイティブの変更には引き続き新しいビルドが必要です。