Skip to content

Commit 1cc79b2

Browse files
committed
Replace ocurrences of Gradle Enterprise with Develocity
1 parent 850b179 commit 1cc79b2

18 files changed

+109
-119
lines changed

Diff for: Gradle.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,13 @@ To get the most out of the experiments and also when building with Develocity du
109109

110110
You can find a complete example of how to apply the Common Custom User Data Gradle plugin to your build [here](https://github.com/gradle/develocity-build-config-samples/tree/main/common-develocity-gradle-configuration-groovy/settings.gradle) for Groovy DSL and [here](https://github.com/gradle/develocity-build-config-samples/blob/main/common-develocity-gradle-configuration-kotlin/settings.gradle.kts) for Kotlin DSL.
111111

112-
## Authenticating with Gradle Enterprise
112+
## Authenticating with Develocity
113113

114-
Some scripts fetch data from build scans that were published as part of running an experiment. The build scan data is fetched by leveraging the [Develocity API](https://docs.gradle.com/enterprise/api-manual/). It is not strictly necessary that you have permission to call these APIs to execute a script successfully, but the summary provided once the script has finished running its experiment will be more comprehensive if the build scan data is accessible.
114+
Some scripts fetch data from build scans that were published as part of running an experiment. The build scan data is fetched by leveraging the [Develocity API](https://docs.gradle.com/develocity/api-manual/). It is not strictly necessary that you have permission to call these APIs to execute a script successfully, but the summary provided once the script has finished running its experiment will be more comprehensive if the build scan data is accessible.
115115

116-
You can check your granted permissions by navigating in the browser to the 'My Settings' section from the user menu of your Develocity UI. You need the 'Access build data via the API' permission. Additionally, the script needs an access key to authenticate with the APIs. See [Authenticating with Develocity](https://docs.gradle.com/enterprise/gradle-plugin/#authenticating) for details on how to create an access key and storing it locally.
116+
You can check your granted permissions by navigating in the browser to the 'My Settings' section from the user menu of your Develocity UI. You need the 'Access build data via the API' permission. Additionally, the script needs an access key to authenticate with the APIs. See [Authenticating with Develocity](https://docs.gradle.com/develocity/gradle-plugin/current/#authenticating) for details on how to create an access key and storing it locally.
117117

118-
By default, the scripts fetching build scan data try to find the access key in the `enterprise/keys.properties` file within the Gradle user home directory (`~/.gradle` by default). Alternatively, the access key can be specified via the `GRADLE_ENTERPRISE_ACCESS_KEY` environment variable. You can also authenticate with the APIs using username and password instead by setting the `GRADLE_ENTERPRISE_USERNAME` and `GRADLE_ENTERPRISE_PASSWORD` environment variables.
118+
By default, the scripts fetching build scan data try to find the access key in the `develocity/keys.properties` file within the Gradle user home directory (`~/.gradle` by default). Alternatively, the access key can be specified via the `DEVELOCITY_ACCESS_KEY` environment variable. You can also authenticate with the APIs using username and password instead by setting the `DEVELOCITY_USERNAME` and `DEVELOCITY_PASSWORD` environment variables.
119119

120120
## Configuring the network settings to connect to Develocity
121121

@@ -140,7 +140,7 @@ The scripts that fetch build scan data expect some of it to be present as custom
140140
## Redirecting build scan publishing
141141

142142
The scripts that run one or more builds locally can be configured to publish build scans to a different
143-
Develocity server than the one that the builds point to by passing the `-s` or `--gradle-enterprise-server`
143+
Develocity server than the one that the builds point to by passing the `-s` or `--develocity-server`
144144
command line argument. In the example below, the script will configure the local builds to publish their build scans
145145
to develocity.example.io regardless of what server is configured in the build.
146146

@@ -151,7 +151,7 @@ to develocity.example.io regardless of what server is configured in the build.
151151
## Instrumenting the build with Develocity
152152

153153
The scripts that run one or more builds locally can be configured to connect the builds to a given Develocity
154-
server in case the builds are not already connected to Develocity by passing the `-e` or `--enable-gradle-enterprise`
154+
server in case the builds are not already connected to Develocity by passing the `-e` or `--enable-develocity`
155155
command line argument. In the example below, the script will configure the non-instrumented builds to connect to the
156156
Develocity server at develocity.example.io.
157157

Diff for: Maven.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ To get the most out of the experiments and also when building with Develocity du
107107

108108
You can find a complete example of how to apply the Common Custom User Data Maven extension to your build [here](https://github.com/gradle/develocity-build-config-samples/blob/main/common-develocity-maven-configuration/.mvn/extensions.xml).
109109

110-
## Authenticating with Gradle Enterprise
110+
## Authenticating with Develocity
111111

112-
Some scripts fetch data from build scans that were published as part of running an experiment. The build scan data is fetched by leveraging the [Develocity API](https://docs.gradle.com/enterprise/api-manual/). It is not strictly necessary that you have permission to call these APIs to execute a script successfully, but the summary provided once the script has finished running its experiment will be more comprehensive if the build scan data is accessible.
112+
Some scripts fetch data from build scans that were published as part of running an experiment. The build scan data is fetched by leveraging the [Develocity API](https://docs.gradle.com/develocity/api-manual/). It is not strictly necessary that you have permission to call these APIs to execute a script successfully, but the summary provided once the script has finished running its experiment will be more comprehensive if the build scan data is accessible.
113113

114-
You can check your granted permissions by navigating in the browser to the 'My Settings' section from the user menu of your Develocity UI. You need the 'Access build data via the API' permission. Additionally, the script needs an access key to authenticate with the APIs. See [Authenticating with Develocity](https://docs.gradle.com/enterprise/maven-extension/#authenticating_with_gradle_enterprise) for details on how to create an access key and storing it locally.
114+
You can check your granted permissions by navigating in the browser to the 'My Settings' section from the user menu of your Develocity UI. You need the 'Access build data via the API' permission. Additionally, the script needs an access key to authenticate with the APIs. See [Authenticating with Develocity](https://docs.gradle.com/develocity/maven-extension/current/#authenticating_with_develocity) for details on how to create an access key and storing it locally.
115115

116-
By default, the scripts fetching build scan data try to find the access key in the `enterprise/keys.properties` file within the Gradle user home directory (`~/.gradle` by default). Alternatively, the access key can be specified via the `GRADLE_ENTERPRISE_ACCESS_KEY` environment variable. You can also authenticate with the APIs using username and password instead by setting the `GRADLE_ENTERPRISE_USERNAME` and `GRADLE_ENTERPRISE_PASSWORD` environment variables.
116+
By default, the scripts fetching build scan data try to find the access key in the `.m2/.develocity/keys.properties` file within the user's home directory. Alternatively, the access key can be specified via the `DEVELOCITY_ACCESS_KEY` environment variable. You can also authenticate with the APIs using username and password instead by setting the `DEVELOCITY_USERNAME` and `DEVELOCITY_PASSWORD` environment variables.
117117

118118
## Configuring the network settings to connect to Develocity
119119

@@ -138,7 +138,7 @@ The scripts that fetch build scan data expect some of it to be present as custom
138138
## Redirecting build scan publishing
139139

140140
The scripts that run one or more builds locally can be configured to publish build scans to a different
141-
Develocity server than the one that the builds point to by passing the `-s` or `--gradle-enterprise-server`
141+
Develocity server than the one that the builds point to by passing the `-s` or `--develocity-server`
142142
command line argument. In the example below, the script will configure the local builds to publish their build scans
143143
to develocity.example.io regardless of what server is configured in the build.
144144

@@ -149,7 +149,7 @@ to develocity.example.io regardless of what server is configured in the build.
149149
## Instrumenting the build with Develocity
150150

151151
The scripts that run one or more builds locally can be configured to connect the builds to a given Develocity
152-
server in case the builds are not already connected to Develocity by passing the `-e` or `--enable-gradle-enterprise`
152+
server in case the builds are not already connected to Develocity by passing the `-e` or `--enable-develocity`
153153
command line argument. In the example below, the script will configure the non-instrumented builds to connect to the
154154
Develocity server at develocity.example.io.
155155

Diff for: components/configure-gradle-enterprise-maven-extension/src/main/java/com/gradle/ConfigureDevelocityAdaptor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ private static void registerBuildScanActions(BuildScanApiAdapter buildScan, Stri
5858
if (buildScan.getServer() == null && !omitServerUrlValidation) {
5959
buildScan.publishAlwaysIf(false); // disable publishing, otherwise scans.gradle.com will be used
6060
File errorFile = new File(EXPERIMENT_DIR, "errors.txt");
61-
append(errorFile, "The Gradle Enterprise server URL has not been configured in the project or on the command line.");
61+
append(errorFile, "The Develocity server URL has not been configured in the project or on the command line.");
6262
}
6363
});
6464

Diff for: components/scripts/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Gradle Enterprise Build Validation Scripts
1+
Develocity Build Validation Scripts
22
==========================================
33

44
Details and instructions on how to use the build validation scripts can be found here:
55
https://github.com/gradle/gradle-enterprise-build-validation-scripts
66

7-
The Gradle Enterprise Build Validation scripts are open-source software released under the Apache 2.0 License:
7+
The Develocity Build Validation scripts are open-source software released under the Apache 2.0 License:
88
https://www.apache.org/licenses/LICENSE-2.0.html

Diff for: components/scripts/gradle/01-validate-incremental-building.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ $(print_separator)
263263
${HEADER_COLOR}Measure build results${RESTORE}
264264
265265
Now that the second build has finished successfully, you are ready to measure
266-
in Gradle Enterprise how well your build leverages Gradle’s incremental build
266+
in Develocity how well your build leverages Gradle’s incremental build
267267
functionality for the invoked set of Gradle tasks.
268268
269269
Some of the build scan data will be fetched from the build scans produced by

Diff for: components/scripts/gradle/02-validate-local-build-caching-same-location.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ $(print_separator)
241241
${HEADER_COLOR}Measure build results${RESTORE}
242242
243243
Now that the second build has finished successfully, you are ready to measure in
244-
Gradle Enterprise how well your build leverages Gradle’s local build caching
244+
Develocity how well your build leverages Gradle’s local build caching
245245
functionality for the invoked set of Gradle tasks.
246246
247247
Some of the build scan data will be fetched from the build scans produced by the

Diff for: components/scripts/gradle/03-validate-local-build-caching-different-locations.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ $(print_separator)
278278
${HEADER_COLOR}Measure build results${RESTORE}
279279
280280
Now that the second build has finished successfully, you are ready to measure in
281-
Gradle Enterprise how well your build leverages Gradle’s local build caching
281+
Develocity how well your build leverages Gradle’s local build caching
282282
functionality for the invoked set of Gradle tasks.
283283
284284
Some of the build scan data will be fetched from the build scans produced by the

Diff for: components/scripts/gradle/04-validate-remote-build-caching-ci-ci.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ Now that the second build has finished successfully, some of the build scan
242242
data will be fetched from the two provided build scans to assist you in your
243243
investigation.
244244
245-
The build scan data will be fetched via the Gradle Enterprise API, as explained
246-
earlier in the preparations section of this experiment.
245+
The build scan data will be fetched via the Develocity API, as explained earlier
246+
in the preparations section of this experiment.
247247
248248
Some of the fetched build scan data is expected to be present as custom values.
249249
By default, this experiment assumes that these custom values have been created
@@ -262,9 +262,9 @@ explain_measure_build_results() {
262262
$(print_separator)
263263
${HEADER_COLOR}Measure build results${RESTORE}
264264
265-
At this point, you are ready to measure in Gradle Enterprise how well your
266-
build leverages Gradle’s remote build cache for the set of Gradle tasks invoked
267-
from two different CI agents.
265+
At this point, you are ready to measure in Develocity how well your build
266+
leverages Gradle’s remote build cache for the set of Gradle tasks invoked from
267+
two different CI agents.
268268
269269
${USER_ACTION_COLOR}Press <Enter> to measure the build results.${RESTORE}
270270
EOF

Diff for: components/scripts/gradle/05-validate-remote-build-caching-ci-local.sh

+6-6
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ validate_required_args() {
149149
fi
150150

151151
if [[ "${enable_ge}" == "on" && -z "${ge_server}" ]]; then
152-
_PRINT_HELP=yes die "ERROR: Missing required argument when enabling Gradle Enterprise on a project not already connected: --gradle-enterprise-server" "${INVALID_INPUT}"
152+
_PRINT_HELP=yes die "ERROR: Missing required argument when enabling Develocity on a project not already connected: --develocity-server" "${INVALID_INPUT}"
153153
fi
154154
}
155155

@@ -309,8 +309,8 @@ Now that the build on CI has finished successfully, some of the build scan
309309
data will be fetched from the provided build scan to assist you in your
310310
investigation.
311311
312-
The build scan data will be fetched via the Gradle Enterprise API, as explained
313-
earlier in the preparations section of this experiment.
312+
The build scan data will be fetched via the Develocity API, as explained earlier
313+
in the preparations section of this experiment.
314314
315315
Some of the fetched build scan data is expected to be present as custom values.
316316
By default, this experiment assumes that these custom values have been created
@@ -415,9 +415,9 @@ explain_measure_build_results() {
415415
$(print_separator)
416416
${HEADER_COLOR}Measure build results${RESTORE}
417417
418-
At this point, you are ready to measure in Gradle Enterprise how well your
419-
build leverages Gradle’s remote build cache for the set of Gradle tasks invoked
420-
from a CI agent and then on a local machine.
418+
At this point, you are ready to measure in Develocity how well your build
419+
leverages Gradle’s remote build cache for the set of Gradle tasks invoked from a
420+
CI agent and then on a local machine.
421421
422422
Some of the build scan data will be fetched from the build scans produced by the
423423
two builds to assist you in your investigation.

Diff for: components/scripts/gradle/gradle-init-scripts/configure-build-validation.gradle

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def failMissingDevelocityServerURL = { def docs ->
7070
errorFile.text = 'The Develocity server URL has not been configured in the project or on the command line.'
7171
throw new IllegalStateException("The Develocity server URL is not configured.\n"
7272
+ "Either configure it directly (see $docs) in the project,\n"
73-
+ "or use --gradle-enterprise-server when running the build validation script.")
73+
+ "or use --develocity-server when running the build validation script.")
7474
}
7575

7676
// fail if a plugin is not applied
@@ -79,7 +79,7 @@ def failMissingPlugin = { def plugin, docs ->
7979
errorFile.text = "The $plugin plugin is missing from the project."
8080
throw new IllegalStateException("The $plugin plugin is missing from the project.\n" +
8181
"Either apply it directly (see $docs),\n" +
82-
"or use --enable-gradle-enterprise when running the build validation script.")
82+
"or use --enable-develocity when running the build validation script.")
8383
}
8484

8585
// do not fail if the CCUD plugin is not applied but surface a warning

Diff for: components/scripts/lib/config.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ validate_required_args() {
9797
fi
9898

9999
if [[ "${enable_ge}" == "on" && -z "${ge_server}" ]]; then
100-
_PRINT_HELP=yes die "ERROR: Missing required argument when enabling Gradle Enterprise on a project not already connected: --gradle-enterprise-server" "${INVALID_INPUT}"
100+
_PRINT_HELP=yes die "ERROR: Missing required argument when enabling Develocity on a project not already connected: --develocity-server" "${INVALID_INPUT}"
101101
fi
102102
}
103103

0 commit comments

Comments
 (0)