From b1965ea60b9fe19c3b2b42e1abbd737dccb3b553 Mon Sep 17 00:00:00 2001 From: Eric Haag Date: Thu, 18 Apr 2024 15:02:03 -0500 Subject: [PATCH 1/2] Provide guidance to user when verification step is unsuccessful --- Gradle.md | 2 ++ Maven.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/Gradle.md b/Gradle.md index a61377b8..d49b3219 100644 --- a/Gradle.md +++ b/Gradle.md @@ -103,6 +103,8 @@ the local builds to publish their build scans to a Develocity server reachable a ./01-validate-incremental-building.sh -t assemble -r https://github.com/gradle/gradle-build-scan-quickstart -e -s https://develocity.example.io ``` +If this does not complete successfully and produce a proper experiment summary, consult the items listed further below. + ## Applying the Common Custom User Data Gradle plugin To get the most out of the experiments and also when building with Develocity during daily development, it is highly recommended that you apply the [Common Custom User Data Gradle plugin](https://github.com/gradle/common-custom-user-data-gradle-plugin) to your build. This free, open-source plugin enhances build scans with additional tags, links, and custom values that are considered during the experiments. diff --git a/Maven.md b/Maven.md index 45dbe36e..08c13a22 100644 --- a/Maven.md +++ b/Maven.md @@ -101,6 +101,8 @@ the local builds to publish their build scans to a Develocity server reachable a ./01-validate-local-build-caching-same-location.sh -g compile -r https://github.com/gradle/maven-build-scan-quickstart -e -s https://develocity.example.io ``` +If this does not complete successfully and produce a proper experiment summary, consult the items listed further below. + ## Applying the Common Custom User Data Maven extension To get the most out of the experiments and also when building with Develocity during daily development, it is highly recommended that you apply the [Common Custom User Data Maven extension](https://github.com/gradle/common-custom-user-data-maven-extension) to your build. This free, open-source plugin enhances build scans with additional tags, links, and custom values that are considered during the experiments. From 688147b96dc145a71a3d028787d4d95b9ba22a05 Mon Sep 17 00:00:00 2001 From: Eric Haag Date: Thu, 18 Apr 2024 15:06:36 -0500 Subject: [PATCH 2/2] Instruct user to invoke a script to verify correct installation --- Gradle.md | 6 ++++++ Maven.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/Gradle.md b/Gradle.md index d49b3219..b5ba0742 100644 --- a/Gradle.md +++ b/Gradle.md @@ -29,6 +29,12 @@ Use the following command to download and unpack the build validation scripts fo curl -s -L -O https://github.com/gradle/gradle-enterprise-build-validation-scripts/releases/download/v2.5.1/gradle-enterprise-gradle-build-validation-2.5.1.zip && unzip -q -o gradle-enterprise-gradle-build-validation-2.5.1.zip ``` +Once downloaded, run the following command to verify that the scripts are set up correctly: + +```bash +./01-validate-incremental-building.sh --version +``` + ## Structure In the top-level folder, there are five different scripts that you can execute, each one representing diff --git a/Maven.md b/Maven.md index 08c13a22..82a8c64d 100644 --- a/Maven.md +++ b/Maven.md @@ -29,6 +29,12 @@ Use the following command to download and unpack the build validation scripts fo curl -s -L -O https://github.com/gradle/gradle-enterprise-build-validation-scripts/releases/download/v2.5.1/gradle-enterprise-maven-build-validation-2.5.1.zip && unzip -q -o gradle-enterprise-maven-build-validation-2.5.1.zip ``` +Once downloaded, run the following command to verify that the scripts are set up correctly: + +```bash +./01-validate-local-build-caching-same-location.sh --version +``` + ## Structure In the top-level folder, there are four different scripts that you can execute, each one representing