コンテンツへスキップ

Gradle キャッシュ

Tuist は、Gradle の組み込みビルドキャッシュと連携してビルド成果物をリモートで共有する Gradle プラグインを提供します。タスクの出力がすでにキャッシュされている場合、Gradle は実行をスキップし、Tuist のリモートキャッシュから結果を取得するため、チームや CI 環境全体でビルド時間を短縮できます。Gradle のローカルおよびリモートビルドキャッシュが up-to-date チェックや構成キャッシュとどのように異なるかについては、ビルドキャッシュとは何か?をご覧ください。キャッシュが遅いビルドのどの部分を削減するのか、またプロジェクトで最初に修正すべき点を確認するには、低速なビルドを参照してください。

Tuist Gradle プラグインをインストールしたら、gradle.properties ファイルで Gradle のビルドキャッシュを有効にする必要があります:

plaintext
org.gradle.caching=true

これを設定しないと、リモートキャッシュを設定していても Gradle はビルドキャッシュサブシステムを活性化せず、すべてのタスクはキャッシュへのヒットや登録を行わずに実行されます。有効にすると、Gradle は Tuist をリモートビルドキャッシュとして使用し、キャッシュヒット時にキャッシュされたタスク出力をダウンロードし、タスク実行後にアップロードします。

キャッシュアップロードポリシー#

デフォルトでは、プラグインはリモートキャッシュへのアーティファクトのダウンロードとアップロードの両方を行います。buildCache ブロック内の push オプションでアップロードを制御できます:

kotlin
tuist {
buildCache {
push = false // read-only mode
}
}

一般的なパターンは、ビルドが再現可能な CI からのみアーティファクトをプッシュし、ローカル環境は読み取り専用モードにすることです:

kotlin
tuist {
buildCache {
push = System.getenv("CI") != null
}
}

この設定により、ローカルビルドはアップロードなしでキャッシュされたアーティファクトの恩恵を受け、CI ビルドはチームの他のメンバーのためにキャッシュに登録します。

継続的インテグレーション#

CI 環境では、認証ガイドに記載された方法のいずれかを使用して認証してください。プロバイダー固有の CI 例については、継続的インテグレーションガイドをご覧ください。

ローカルビルドキャッシュの無効化#

Gradle はローカルビルドキャッシュとリモートビルドキャッシュの両方を維持します。ローカルビルドキャッシュは、~/.gradle/caches/build-cache-1 以下のディスク上にタスク出力を保存します。

Tuist がリモートビルドキャッシュとして構成されている場合、CI でローカルビルドキャッシュを無効にすることをお勧めします。これにより、CI ランナー上に冗長なアーティファクトが保存されるのを防ぎ、ビルドが常にチームの他のメンバーのために新しいエントリでリモートキャッシュに登録されることを保証します。

settings.gradle.kts で CI 上の Gradle ローカルビルドキャッシュを無効にします:

kotlin
buildCache {
local {
isEnabled = System.getenv("CI") == null
}
}

これにより、ローカル開発ではローカルビルドキャッシュを利用可能にしつつ、Tuist のリモートキャッシュがアーティファクト共有を処理する CI では無効にします。

構成リファレンス#

buildCache ブロックは以下をサポートします:

オプション 型 デフォルト 説明
enabled Boolean true リモートビルドキャッシュを有効にするかどうか。
push Boolean true タスク出力をリモートキャッシュにアップロードするかどうか。
allowInsecureProtocol Boolean false 安全でない HTTP 接続を許可するかどうか。