前回の週次リリース v2.5.0(11月13日)から、19日の v2.5.1 と 20日の v2.6.0 にかけて、PRのレビュー体験・iOSシミュレーターでのE2Eテスト・GitHub Releaseからの自動配布まで一気に拡張しました。ワークフローSDKは openci_workflow 0.5.3 に更新し、2台シミュレーター向けの仮想BLEプラグイン openci_virtual_ble 0.1.0 も公開しています。

今週のハイライト

  • PRのフィードバックを短縮: CIが失敗したときにエラー行へのリンク付き要約をPRへ自動コメント。ダッシュボードからのジョブ再実行や、有効期限付きのWebプレビューにも対応しました。
  • iOSシミュレーターのE2EをDartで完結: クリーンなシミュレーターの起動・破棄、シークレットを渡せるPatrolテスト、2台のシミュレーター間での仮想BLE通信テストをSDKに組み込みました。
  • リリースと公開を自動化: GitHub Releaseの公開を起点にする CITrigger.release() に加え、Firebase FunctionsのデプロイAPIと pub.dev 自動公開APIを追加しました。
  • Dart / Flutter SDKを拡充: 型付きの実行コンテキスト ci.context、dart.runBuildRunner()・dart.analyze()・dart.test()、FlutterVersion プリセット、firebase.json 読み込みを追加しました。
  • チーム運用と実行基盤を改善: リポジトリのWrite権限でのGitHub接続、ビルド一覧での当月CI利用見込額表示、ビルドVMの標準4 vCPU化に対応しました。

PRの失敗をその場で追い、再実行まで短くする

エラー行リンク付きの失敗コメント

PRのワークフローが失敗またはタイムアウトすると、OpenCIは失敗したステップのログからエラーを抽出し、そのPRの会話欄に要約を投稿します。flutter analyze・dart analyze・コンパイラ形式の診断メッセージは、テスト対象コミットの該当ファイルと行番号へのリンク付きで並ぶため、長いビルドログをさかのぼらずに問題箇所へ飛べます。

同じワークフローが続けて失敗した場合は同じコメントが更新され、修正後に成功すると解決済みに切り替わり、前回のエラーは折りたたまれます。PRコメントの実例

ダッシュボードからの再実行と安定したチェックアウト

一時的な失敗をもう一度試したいときは、ダッシュボードのジョブ詳細から 再実行 を選べます。終了済みのmacOSジョブが対象で、保存されたリビジョンのまま新しい実行をキューへ積みます。待機中は前回のログを読めて、新しい実行が始まると自動で表示が切り替わり、新しいGitHub Checkも付きます。PR #3959

PRチェックアウトでは、ベースブランチとPR先端を再確認したうえで、GitHubのテスト用マージコミットが最新ならそれを使い、準備が間に合わない場合はビルドVM内で確認済みの2つのコミットをローカルマージします。コンフリクトがあればチェックアウトで止まり、実際にテストしたマージコミットがログに残ります。PRのマージ先を変更した直後にforce-pushした場合でも、古いWebhook通知が最新のビルド計画を中断しないようにしました。PR #3962 · PR #3992

実行コンテキストでの分岐と、有効期限付きWebプレビュー

ci.context を使うと、実行のきっかけになったイベントを PullRequestContext・PushContext・LocalContext として型安全に分岐できます。あわせて、Firebase Hostingの deploy() と deployPreview() が firebaseConfigPath: 'firebase.json' から公開ディレクトリ、除外パターン、静的ルーティング、レスポンスヘッダーを直接読み込めるようになりました。Node.jsやFirebase CLIのインストールは不要です。

deployPreview() はURLとFirebaseが返した実際の有効期限(UTC)を含む FirebaseHostingPreview を返します。次のように postQrCode() へ渡すと、PRコメントに有効期限が表示されます。

switch (ci.context) {
  case PullRequestContext(:final number):
    final preview = await ci.firebaseHosting.deployPreview(
      siteId: 'my-hosting-site',
      channelId: 'pr-$number',
      expiresIn: const Duration(days: 7),
      firebaseConfigPath: 'firebase.json',
      serviceAccountJsonBase64:
          Secrets.firebaseHostingServiceAccountJsonBase64.value,
    );
    await ci.pullRequest.postQrCode(
      url: preview.url,
      expiresAt: preview.expiresAt,
    );
  case PushContext(branch: 'main'):
    await ci.firebaseHosting.deploy(
      siteId: 'my-hosting-site',
      firebaseConfigPath: 'firebase.json',
      serviceAccountJsonBase64:
          Secrets.firebaseHostingServiceAccountJsonBase64.value,
    );
  case PushContext() || LocalContext():
    break;
}

コメントを日本語にする場合は postQrCode() に lang: PostQrCodeLang.ja を渡します。この公式サイトのPRプレビューと本番公開も同じ構成で動いています。公式サイトのワークフロー

iOSシミュレーターとPatrolで、UIから2台間のBLE通信までテストする

クリーンなシミュレーター起動とPatrolテスト

launchIosSimulator() は新しいiOSシミュレーター(既定はiPhone 17 Pro、Xcodeの対応最新ランタイム)を作成して起動完了まで待ち、そのUDIDを返します。finally で simulator.dispose() を呼べば、テストが失敗してもシミュレーターを確実に終了・削除できます。

patrol.test() はプロジェクトで解決済みの patrol_cli を使ってテストを実行します。env に生成済みの Secret を渡すと、一時ファイル経由で --dart-define として安全に注入し、テストコード側では const String.fromEnvironment(...) で元のキー名から読み取れます。一時ファイルは実行終了後に自動で削除されます。

final simulator = await ci.launchIosSimulator(
  name: 'App Patrol',
);
try {
  await ci.patrol.test(
    dir: 'apps/mobile',
    device: simulator.id,
    targets: ['patrol_test/login_test.dart'],
    env: [
      Secrets.testAccountEmail,
      Secrets.testAccountPassword,
    ],
  );
} finally {
  await simulator.dispose();
}

macOSベースイメージ v0.1.9 には Patrol CLI 4.9.0 をプリインストール済みです。OpenCI自身のダッシュボードアプリも、毎回新しいシミュレーターを起動し、ログイン画面の操作からFirebase認証、所属チームの読み込みまでをPatrolで検証しています。ダッシュボードのワークフロー

2台のシミュレーターで仮想BLE通信を検証する

Bluetooth Low Energy(BLE)で端末同士がやり取りする機能は、実機2台や物理的な無線環境が必要になり、CIでの自動テストが難しい領域でした。v2.6.0では、1台のMac上に2台のiOSシミュレーターとホスト側のBumble仮想GATTデバイスを立ち上げ、ループバックWebSocket経由でGATTの読み取りと書き込み応答を往復できる仕組みを追加しました。

ci.patrol.testWithVirtualBle() は、Patrolターゲットを一度ビルドして2台の新規シミュレーターにインストールし、Peer B がGATTキャラクタリスティックを公開してから Peer A を起動します。実行後は両方のシミュレーターと仮想BLEセッションを破棄し、端末ごとのログ、XCTest結果バンドル、任意のJSON(A.json / B.json)を出力ディレクトリに残します。

await ci.patrol.testWithVirtualBle(
  dir: 'apps/mobile',
  target: 'patrol_test/pairing_test.dart',
  bundleId: 'com.example.app',
  serviceUuid: 'BE110001-5D9F-4810-8692-47717E010001',
  characteristicUuid: 'BE110002-5D9F-4810-8692-47717E010001',
  resultJsonFile: 'ble-result.json',
);

Flutterアプリ向けのシミュレータークライアントプラグイン openci_virtual_ble 0.1.0 も pub.dev に公開しました(flutter pub add --dev openci_virtual_ble)。Swift側でBLEプロトコルを実装しているアプリでも、#if DEBUG && targetEnvironment(simulator) 下で VirtualBleConnection を利用できます。より細かい制御が必要な場合は、低レベルAPIの ci.startVirtualBle() も使えます。2台シミュレーターのFlutterサンプル

すでに実際のアプリ開発でも活用が始まっています。@aqhayami さんのアプリ「issho」でもOpenCIと仮想BLEを導入いただき、複数のシミュレーターでBluetoothペアリングの動作を確認するE2Eテストが動いています。

ちなみに複数のシミュレーターでBluetoothペアリングの動作確認をするE2E組んでいただきました。これからバリバリ活用していきます🙏

— aq (@aqhayami) / X

GitHub Releaseを起点に、アプリ・Functions・パッケージを届ける

GitHub ReleaseトリガーとFirebase Functionsデプロイ

CITrigger.release(tag: 'v*') は、パターンに一致するGitHub Release(プレリリース含む)を公開したときにだけワークフローを起動します。ドラフト保存やタグだけのpushでは実行されず、タグが指す正確なコミットからワークフローを読み取ってチェックアウトするため、通常の開発ブランチとリリース作業をきれいに分けられます。利用にはGitHub Appでの Release イベント購読とContents読み取り権限が必要です。トリガーガイド

バックエンド向けには、ci.firebase.functions.deploy()(SDK 0.5.3)を追加しました。インストール済みのFirebase CLIを呼び出し、Base64エンコードしたサービスアカウントJSONを一時的なADCファイルとして渡してデプロイします。既存のFirebaseログイン状態からは隔離され、成功・失敗にかかわらず一時ファイルは確実に削除されます。codebase を省略すれば全コードベースが対象です。

final ci = await OpenCI.init(
  workflowName: 'Release Functions',
  flutterVersion: FlutterVersion.v3_47_8.value,
  ciTriggers: [CITrigger.release(tag: 'v*')],
);

await ci.firebase.functions.deploy(
  projectId: 'my-firebase-project',
  codebase: 'api',
  firebaseConfigPath: 'firebase/firebase.json',
  serviceAccountJsonBase64:
      Secrets.firebaseServiceAccountJsonBase64.value,
);

pub.devへの自動公開とOpenCI自身のリリース運用

Dartパッケージ作者向けに ci.dart.publishToPubDev() を追加しました。GoogleサービスアカウントによるIDトークン認証に対応しており、gcloud なしで dart pub publish --force を実行できます。一時トークンは隔離・終了時に削除され、ログ出力からもマスクされます。skipIfPublished: true を指定すれば、同じバージョンでジョブを再実行した際に既公開のアップロードをスキップできます。

await ci.dart.publishToPubDev(
  serviceAccountJsonBase64:
      Secrets.pubDevServiceAccountJsonBase64.value,
  skipIfPublished: true,
);

OpenCI自身でもこれらの仕組みを本番のリリース運用に組み込みました。GitHub Releaseの公開を起点に、ダッシュボードのShorebirdリリースビルドをTestFlightとGoogle Play内部テストへ配布し、バックエンドのTypeScript製Firebase FunctionsとDart製プランナーもリリースタグからテスト・デプロイしています。develop へのマージでは、変更内容に応じたShorebirdパッチ配信や、2台BLEテストを通過したうえでの openci_workflow のpub.dev公開まで自動化しています。SDK公開ワークフロー · Functionsデプロイ

Dart / Flutter ワークフローSDKの拡充

今週の更新で openci_workflow は 0.2.9 から 0.5.3 へ進み、コード生成・解析・テストの定番ステップを型付きメソッドで書けるようになりました。dart.test() には特定ファイルだけを実行する paths 引数を追加し、Flutter側ではロックファイルを厳密に守る flutter.pubGet(enforceLockfile: true) と、依存解決をやり直さない flutter.staticAnalysis(noPub: true) にも対応しています。

const pkg = 'packages/my_package';
await ci.dart.runBuildRunner(dir: pkg);
await ci.dart.analyze(dir: pkg, fatalInfos: true);
await ci.dart.test(dir: pkg, paths: ['test/core_test.dart']);

const app = 'apps/mobile';
await ci.flutter.pubGet(dir: app, enforceLockfile: true);
await ci.flutter.staticAnalysis(dir: app, noPub: true);

また、OpenCI.init の flutterVersion にはプリセットとして FlutterVersion.v3_44_8.value と FlutterVersion.v3_47_8.value を用意し、プランナー側の解決にも対応しました。詳しい書き方は ワークフローガイド にまとめています。

チーム管理・コスト可視化・ビルド基盤の改善

  • リポジトリのWrite権限でのGitHub接続: GitHub Appがインストール済みなら、OrganizationのOwner権限がなくても、リポジトリのWrite・Maintain・Admin権限を持つメンバーが個別リポジトリをOpenCIチームへ接続できるようになりました。1つのOrganizationのインストールを、リポジトリごとに別々のOpenCIチームへ割り当てることもできます。PR #3950
  • ビルド一覧で当月のCI利用見込額を確認: Webダッシュボードのビルド一覧上部に、選択中のCloudチームの当月利用見込額(税込・円)を表示します。その場で見込額を更新したり、金額をクリックして請求詳細へ進んだりできます。PR #3989
  • アカウント登録とチーム追加: ダッシュボードの新規登録を Google で続行 に統一しました。初回セットアップが途中で中断しても、次回サインイン時に所属チームを確認して自動で再開します。既存のメール・パスワードアカウントでは引き続きサインインでき、設定の「チーム作成」から追加チームも作成できます。PR #3969 · PR #3924
  • ビルドVMの標準4 vCPU化とベースイメージ更新: OrchardビルドVMの標準CPU割り当てを4 vCPUに引き上げました(M1 Macワーカーは安定稼働のため1 VM上限に設定)。macOSベースイメージ v0.1.9 には Patrol CLI 4.9.0 を同梱しています。PR #3978 · PR #3958

SDK更新時の確認点

openci_workflow を 0.2.9 以前から 0.5.3 へ更新する際は、次の3点を確認してください。

  • firebaseHosting.deployPreview() の戻り値(0.4.0): Uri から FirebaseHostingPreview に変わりました。URLは preview.url、有効期限は preview.expiresAt を参照してください。本番用の deploy() は引き続き Uri を返します。
  • CITrigger への release 追加(0.5.0): CITrigger に3つ目のケースが加わりました。網羅的な switch / when / map を使っている場合は release の分岐を追加してください。
  • OpenCI.go の削除(0.3.0): v2.5.0時点のソース変更に含まれていたGoヘルパーの削除が、pub.dev公開版にも反映されています。

GitHub Release v2.6.0 · v2.5.1からの変更 · v2.5.0からの全変更 · openci_workflow 0.5.3

表紙撮影 Quinn Battick / Unsplash