Skip to content
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

Provide additional guidance to users for verifying installation #604

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions Gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -103,6 +109,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.
Expand Down
8 changes: 8 additions & 0 deletions Maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -101,6 +107,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.
Expand Down