Skip to content

Commit 55ab5fe

Browse files
Add section 'Verifying the setup' (#603)
* Add Gradle section 'Verifying the setup' Signed-off-by: Etienne Studer <[email protected]> * Use a different sample repo Signed-off-by: Etienne Studer <[email protected]> * Add Maven section 'Verifying the setup' Signed-off-by: Etienne Studer <[email protected]> --------- Signed-off-by: Etienne Studer <[email protected]>
1 parent 71e9f1f commit 55ab5fe

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

Diff for: Gradle.md

+9
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ The scripts return with an exit code that depends on the outcome of running a gi
9494
| 3 | The build was not fully cacheable for the given task graph and `--fail-if-not-fully-cacheable` was set |
9595
| 100 | An unclassified, fatal error happened while running the experiment |
9696

97+
## Verifying the setup
98+
99+
You can verify that the script can properly interact with your Develocity server. In the example below, the script will configure
100+
the local builds to publish their build scans to a Develocity server reachable at develocity.example.io.
101+
102+
```bash
103+
./01-validate-incremental-building.sh -t assemble -r https://github.com/gradle/gradle-build-scan-quickstart -e -s https://develocity.example.io
104+
```
105+
97106
## Applying the Common Custom User Data Gradle plugin
98107

99108
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 for: Maven.md

+9
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,15 @@ The scripts return with an exit code that depends on the outcome of running a gi
9292
| 3 | The build was not fully cacheable for the given execution plan and `--fail-if-not-fully-cacheable` was set |
9393
| 100 | An unclassified, fatal error happened while running the experiment |
9494

95+
## Verifying the setup
96+
97+
You can verify that the script can properly interact with your Develocity server. In the example below, the script will configure
98+
the local builds to publish their build scans to a Develocity server reachable at develocity.example.io.
99+
100+
```bash
101+
./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
102+
```
103+
95104
## Applying the Common Custom User Data Maven extension
96105

97106
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.

0 commit comments

Comments
 (0)