Skip to content

Add section 'Verifying the setup' #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Gradle.md
Original file line number Diff line number Diff line change
@@ -94,6 +94,15 @@ The scripts return with an exit code that depends on the outcome of running a gi
| 3 | The build was not fully cacheable for the given task graph and `--fail-if-not-fully-cacheable` was set |
| 100 | An unclassified, fatal error happened while running the experiment |

## Verifying the setup

You can verify that the script can properly interact with your Develocity server. In the example below, the script will configure
the local builds to publish their build scans to a Develocity server reachable at develocity.example.io.

```bash
./01-validate-incremental-building.sh -t assemble -r https://github.com/gradle/gradle-build-scan-quickstart -e -s https://develocity.example.io
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just running help is enough to verify connectivity. That would avoid 0.5s of unnecessary waiting time.

assemble is fine too though. 😉

```

## 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.
9 changes: 9 additions & 0 deletions Maven.md
Original file line number Diff line number Diff line change
@@ -92,6 +92,15 @@ The scripts return with an exit code that depends on the outcome of running a gi
| 3 | The build was not fully cacheable for the given execution plan and `--fail-if-not-fully-cacheable` was set |
| 100 | An unclassified, fatal error happened while running the experiment |

## Verifying the setup

You can verify that the script can properly interact with your Develocity server. In the example below, the script will configure
the local builds to publish their build scans to a Develocity server reachable at develocity.example.io.

```bash
./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
```

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