跳至內容

Gradle 快取

Tuist 提供一個 Gradle 外掛程式,可與 Gradle 內建的建置快取 整合,以遠端共用建置產物。當任務的輸出已存在於快取中時,Gradle 會略過執行並從 Tuist 的遠端快取取得結果,為你的團隊與 CI 環境節省建置時間。

安裝 Tuist Gradle 外掛程式 後,你還需要在 gradle.properties 檔案中啟用 Gradle 的建置快取:

plaintext
org.gradle.caching=true

若未進行此設定,即使已設定遠端快取,Gradle 也不會啟動其建置快取子系統,所有任務都會執行而不會命中或填入快取。啟用後,Gradle 會將 Tuist 作為遠端建置快取使用,在快取命中時下載已快取的任務輸出,並在任務執行後上傳。

快取上傳政策#

預設情況下,外掛程式會同時從遠端快取下載並上傳產物。你可以透過 buildCache 區塊中的 push 選項來控制上傳行為:

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

常見的做法是僅從 CI 推送產物(因為 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
}
}

這樣可讓本機建置快取在本機開發時保持可用,同時在 CI 上停用,由 Tuist 的遠端快取負責處理產物共用。

設定參考#

buildCache 區塊支援以下選項:

選項類型預設值說明
enabledBooleantrue是否啟用遠端建置快取。
pushBooleantrue是否將任務輸出上傳至遠端快取。
allowInsecureProtocolBooleanfalse是否允許不安全的 HTTP 連線。