Skip to content

Commit b86d88b

Browse files
committed
Document script exit codes
1 parent b629517 commit b86d88b

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
@@ -84,6 +84,15 @@ is invoked, as shown in the example below.
8484
./02-validate-local-build-caching-same-location.sh -i -r https://github.com/gradle/gradle-build-scan-quickstart
8585
```
8686

87+
The scripts return with an exit code that depends on the outcome of running a given experiment.
88+
89+
| Exit Code | Reason |
90+
|-----------|--------------------------------------------------------------------------------------------------------|
91+
| 0 | The experiment completed successfully |
92+
| 1 | An invalid input was provided while attempting to run the experiment |
93+
| 2 | One of the builds that is part of the experiment failed |
94+
| 3 | The build was not fully cacheable for the given task graph and `--fail-if-not-fully-cacheable` was set |
95+
8796
## Applying the Common Custom User Data Gradle plugin
8897

8998
To get the most out of the experiments and also when building with Gradle Enterprise 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
@@ -82,6 +82,15 @@ is invoked, as shown in the example below.
8282
./01-validate-local-build-caching-same-location.sh -i -r https://github.com/gradle/maven-build-scan-quickstart
8383
```
8484

85+
The scripts return with an exit code that depends on the outcome of running a given experiment.
86+
87+
| Exit Code | Reason |
88+
|-----------|--------------------------------------------------------------------------------------------------------|
89+
| 0 | The experiment completed successfully |
90+
| 1 | An invalid input was provided while attempting to run the experiment |
91+
| 2 | One of the builds that is part of the experiment failed |
92+
| 3 | The build was not fully cacheable for the given task graph and `--fail-if-not-fully-cacheable` was set |
93+
8594
## Applying the Common Custom User Data Maven extension
8695

8796
To get the most out of the experiments and also when building with Gradle Enterprise 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)