CIでXcodeのビルドを高速化する
最終更新日
CI 上の Xcode ビルドが遅くなるのには、予測しやすい理由があります。パッケージの初回ダウンロード、フルリコンパイル、シミュレーターの起動時間、小さな VM 上でのテスト実行です。Mac の実行時間は高額なため、これらのそれぞれが実際のコストにつながります。本ガイドでは、効果のある方法と効果のない方法を解説します。
環境を固定する
まず、実行結果を比較できるようにします。ランナーイメージと Xcode のバージョンを固定してください。
runs-on: macos-15
steps:
- uses: actions/checkout@v4
- run: sudo xcode-select -s /Applications/Xcode_16.4.app
- run: xcodebuild -version
使用中のイメージで利用可能な Xcode のバージョンは、runner-images リポジトリの README で確認してください。イメージの更新に伴い、利用可能なパスは変わります。macos-latest を使うと、既定値が変わったときにビルドが予期せず変化する可能性があります。
Swift Package Manager の依存関係をキャッシュする
コールドなランナーでは、パッケージの解決とクローンに 1 分以上かかることがあります。xcodebuild にクローンの保存先を指定し、そのディレクトリをキャッシュしてください。
- uses: actions/cache@v4
with:
path: .spm
key: spm-${{ runner.os }}-${{ hashFiles('**/Package.resolved') }}
restore-keys: spm-${{ runner.os }}-
- run: |
xcodebuild -resolvePackageDependencies \
-scheme MyApp \
-clonedSourcePackagesDirPath .spm
後続の build および test コマンドにも同じ -clonedSourcePackagesDirPath .spm を指定します。キーを安定させ、ビルドを再現可能にするため、Package.resolved はコミットしてください。
CocoaPods の場合は、Podfile.lock をキーにして Pods ディレクトリをキャッシュするか、より良い方法として ~/.cocoapods をキャッシュし、pod install を実行してロックファイルを正としてください。Carthage を使う場合は Carthage/Build をキャッシュし、--use-xcframeworks を付けて XCFramework を利用してください。
DerivedData に注意する
~/Library/Developer/Xcode/DerivedData をキャッシュするのは、コンパイルが遅いときに試したくなる対策ですが、期待外れに終わることが多いです。Xcode の増分ビルドの判断は、ファイルの更新日時と絶対パスに依存します。新しく git checkout すると、すべてのソースファイルの更新日時が新しくなるため、Xcode はすべてが変更されたとみなして再ビルドします。数ギガバイトのキャッシュを復元するための時間は、その時点で無駄になっています。
効果のある方法は次のとおりです。
- 依存関係ごとのビルド成果物をキャッシュする: 変更されない依存関係については、バージョンをキーにして、ポッドやパッケージ向けに生成したビルド済み XCFramework をキャッシュします。
- コンパイラーキャッシュを使う: C、C++、Objective-C の部分には ccache などを使い、Bazel や Tuist のキャッシュ機能を使う場合はビルドシステムのキャッシュを利用します。
- テストしていない限り、ジョブ間で共有の DerivedData パスは避けてください。
-derivedDataPath buildを設定すると、保存場所が明示的になり、毎回同じになります。
DerivedData のキャッシュを試す場合は、ビルドログでコールドな実行とウォームな実行を比較してください。ウォームな実行でもほとんどのファイルがコンパイルされる場合は、キャッシュを削除してください。その場合、リポジトリの 10 GB の上限からストレージを消費しているだけで、効果がありません。
ビルドは一度だけ行い、テストは並列で実行する
一度コンパイルしてから、テストをさまざまな方法で実行します。
- run: |
xcodebuild build-for-testing \
-scheme MyApp \
-destination 'platform=iOS Simulator,name=iPhone 16' \
-derivedDataPath build \
-clonedSourcePackagesDirPath .spm
- run: |
xcodebuild test-without-building \
-scheme MyApp \
-destination 'platform=iOS Simulator,name=iPhone 16' \
-derivedDataPath build \
-parallel-testing-enabled YES
ビルド成果物をアーティファクトとしてアップロードし、-only-testing: フィルターを付けて test-without-building を複数のジョブに分散させることもできます。ジョブが増えるたびに、Mac の料金で最低 1 分が課金されるため、テストスイートが数分以上かかる場合にのみ行ってください。
テストのコストを下げる
- PR ビルドでは 1 つのシミュレーターを選ぶ: 最新の iPhone など 1 つを選び、より広いデバイスマトリクスは夜間に実行します。宛先が増えるたびに実行時間も増えます。
- シミュレーターを早めに起動する: パッケージの解決中にウォームアップされるよう、バックグラウンドのステップとして
xcrun simctl boot "iPhone 16"を実行します。利用可能なデバイスはxcrun simctl list devices availableで確認できます。 - 並列テスト(
-parallel-testing-enabled YES)は、シミュレーターを複製してテストクラスを同時に実行します。グローバルな状態を共有しないテストが必要で、メモリ使用量も増えるため、7 GB の標準ランナーでは注意が必要です。 - すべての push で UI テストを省く。 UI テストは遅く、不安定になりがちです。マージ時やラベル付与時に実行してください。
- コードカバレッジを無効にする: PR の実行では、不要な結果バンドルとあわせて
-enableCodeCoverage NOを指定してください。
コンパイル作業を減らす
- 依存関係のマクロやプラグインを信頼できる場合にのみ、
-skipMacroValidationと-skipPackagePluginValidationを使ってください。そうしないと、CI が承認を待って停止します。先にセキュリティ上のトレードオフを理解しておいてください。 - CI のビルドでは
COMPILER_INDEX_STORE_ENABLE=NOを設定してください。インデックス作成はエディターのためのもので、ビルドのためではありません。 - テストでは Debug 構成をビルドしてください。モジュール全体の最適化を伴う Release ビルドは大幅に遅く、アーカイブの場合にのみ必要です。
- 大きなターゲットをモジュールに分割すると、変更時の再コンパイルが減ります。開発者のマシンでも効果があります。
- シミュレーター向けのビルドでは
ARCHS=arm64(またはONLY_ACTIVE_ARCH=YES)を指定し、ランナーが使用しないアーキテクチャ向けにコンパイルしないようにしてください。
時間だけでなく、料金も削減する
Mac の実行時間は高額です。速度向上の作業は、iOS CI 向けの macOS ランナーのコストに関するルールと組み合わせてください。リンターは Linux で実行し、置き換えられた実行はキャンセルし、timeout-minutes を設定し、より大きな Mac に移行する前に実行ごとのコストを測定します。コスト計算ツールに数値を入力して、月間の効果を確認してください。
推奨される進め方
- Xcode とランナーイメージを固定する。
- SPM または Pods をキャッシュする。
build-for-testingでビルドとテストを分ける。- PR の実行から宛先と UI テストを減らす。
- より大きなランナーを試し、実行ごとのコストを比較する。
よくある質問
DerivedData はキャッシュすべきですか?
コミットする前に、まず検証してください。チェックアウトによってファイルの更新日時がリセットされ、Xcodeの増分ビルドのロジックが効かなくなることがよくあります。依存関係のキャッシュは、より安全な最初のステップです。
シミュレーターのテストがCIではローカルより遅いのはなぜですか?
CI用のMacは、開発者のノートPCに比べてコア数やメモリが少なく、シミュレーターはコールドスタートになります。早めにシミュレーターを起動し、メモリ不足の兆候が見られる場合は並列ワーカー数を減らしてください。
大きなランナーはXcodeに効果がありますか?
Xcodeは並列でコンパイルするため、通常は効果があります。M2 Pro 5コアランナーは1分あたり$0.102で、標準ランナーの$0.062と比べて高額です。そのため、コストを抑えるには少なくとも1.65倍速い必要があります。
遅いターゲットを見つけるには?
-showBuildTimingSummary を xcodebuild に追加し、ログの末尾にあるサマリーを確認するか、Swift の -Xfrontend -warn-long-function-bodies=500 を有効にして、型チェックに時間がかかる関数を見つけてください。
ご自身のプロジェクトで比較する
ビルド時間はプロジェクトによって大きく異なります。compiler.devの比較モードを使うと、macOSのワークフローを1つ、早期アクセス版のM4 Proランナーで実行し、現在のランナーと実行時間およびコストを比較できます。パイプラインの他の部分を変更する必要はありません。
関連記事
- GitHub ActionsでTypeScriptモノレポを高速化するGitHub Actionsで TypeScriptモノレポの型チェックとリンターを高速化する: インクリメンタルtsc、プロジェクト参照、Lintキャッシュ、並列ジョブ
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- READMEにCIの速度バッジを追加するREADME のバッジで CI の速さを表示しましょう。リポジトリの GitHub Actions 実行時間の中央値が自動で更新されます。公開リポジトリは無料です。
- GitHub Actionsで.NETを高速化するGitHub Actions で .NET のビルドを高速化する: setup-dotnet による NuGet キャッシュ、--no-restore、--no-build、並列の dotnet test、SQL Server サービス。