目錄
1.創建構建掃描
構建掃描是構建的可共享且集中的記錄,可提供有關發生情況和原因的見解。通過將構建掃描插件應用於您的項目,您可以免費將構建掃描發佈到https://scans.gradle.com。
1.1.您將創建什麼
本指南說明如何在不修改任何構建腳本的情況下臨時發佈構建掃描。您還將學習如何修改構建腳本以對給定項目的所有構建啓用構建掃描。(可選)您還將修改一個初始化腳本,以對所有項目啓用構建掃描。
1.2.你需要什麼
- 您可以使用自己的示例項目,也可以使用Gradle提供的示例項目
- 上網
- 訪問您的電子郵件
- 約6分鐘
1.3.選擇一個樣本項目
Gradle提供了一個簡單的Java項目,可用於演示構建掃描功能。如果您想使用它,請克隆或下載存儲庫。如果您喜歡使用自己的項目,則可以跳過此步驟。
1.4.自動應用構建掃描插件
從Gradle 4.3開始,您無需在構建腳本中進行任何其他配置即可啓用構建掃描。使用命令行選項--scan
發佈構建掃描時,所需的構建掃描插件將自動應用。在構建結束之前,要求您在命令行上接受許可協議。以下控制檯輸出演示了該行爲。
$ ./gradlew build --scan
BUILD SUCCESSFUL in 6s
Do you accept the Gradle Cloud Services license agreement (https://gradle.com/terms-of-service)? [yes, no]
yes
Gradle Cloud Services license agreement accepted.
Publishing build scan...
https://gradle.com/s/czajmbyg73t62
這種機制使生成臨時的一次性構建掃描變得非常容易,而無需在構建中配置構建掃描插件。如果需要更精細的配置,可以按照以下各節中的說明,在構建或初始化腳本中配置構建掃描插件。
1.5.在項目的所有構建中啓用構建掃描
對於Gradle 2.x-5.x,您需要將com.gradle.build-scan
插件應用於根構建腳本。對於Gradle 6.0,您需要將com.gradle.enterprise
插件應用於settings
腳本。
按照Gradle Build Scan插件文檔進行操作,以將Build Scan插件應用於您的項目。
1.6.接受許可協議
爲了將構建掃描發佈到https://scans.gradle.com,您需要接受許可協議。發佈時可以通過命令行臨時完成,也可以通過添加以下部分在Gradle構建文件中指定:
Groovy
settings.gradle
gradleEnterprise {
buildScan {
termsOfServiceUrl = 'https://gradle.com/terms-of-service'
termsOfServiceAgree = 'yes'
}
}
Kotlin
settings.gradle.kts
gradleEnterprise {
buildScan {
termsOfServiceUrl = "https://gradle.com/terms-of-service"
termsOfServiceAgree = "yes"
}
}
該buildScan
塊允許您配置插件。在這裏,您將設置接受許可協議所需的兩個屬性。其他屬性可用。有關詳細信息,請參見《Build Scans用戶手冊》。
1.7.發佈構建掃描
使用稱爲的命令行標誌發佈構建掃描--scan
。
build
使用該--scan
選項運行任務。構建完成後,將構建數據上傳到scans.gradle.com之後,將爲您提供一個鏈接,以查看構建掃描。
$ ./gradlew build --scan
BUILD SUCCESSFUL in 0s
Publishing build scan...
https://gradle.com/s/uniqueid
1.8.在線訪問構建掃描
首次單擊該鏈接時,將要求您激活創建的構建掃描。
您收到的用於激活構建掃描的電子郵件將類似於:
單擊電子郵件中提供的鏈接,您將看到創建的構建掃描。
現在,您可以瀏覽構建掃描中包含的所有信息,包括執行任務所花費的時間,構建每個階段所需的時間,任何測試的結果,所使用的插件和其他依賴項,所使用的任何命令行開關, 和更多。
1.9.爲所有構建啓用構建掃描(可選)
您可以避免使用Gradle初始化腳本將插件和許可協議添加到每個版本中。
您可以向腳本添加其他功能,例如在什麼條件下發布掃描信息。有關詳細信息,請參見《Build Scans用戶手冊》。
1.10.摘要
在本指南中,您學習瞭如何:
-
生成構建掃描
-
在線查看構建掃描信息
-
創建一個初始化腳本以啓用對所有構建的構建掃描
其他信息可以在《Build Scans用戶手冊》中找到。
1.11.幫助完善本指南
有意見或問題嗎?找到錯字了?像所有Gradle指南一樣,幫助只是GitHub問題而已。請在gradle-guides/creating-build-scans中添加問題或請求,我們將盡快與您聯繫。