From c8a1bc36ae47add3cdd4ce3d8ad7c95d49bbc899 Mon Sep 17 00:00:00 2001 From: daz Date: Wed, 10 Jan 2024 19:15:48 -0700 Subject: [PATCH] Update Develocity injection example in README - Use `develocity.your-server.com` consistently in examples - Remove access key from example, since it's unrelated to the actual DV injection (And the access key name remains at `GRADLE_ENTERPRISE_ACCESS_KEY`) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f756dae..3bc3001 100644 --- a/README.md +++ b/README.md @@ -792,7 +792,7 @@ The same auto-injection behavior is available for the Common Custom User Data Gr ## Enabling Develocity injection -In order to enable Develocity for your build, you must provide the required configuration via environment variables. +In order to enable Develocity injection for your build, you must provide the required configuration via environment variables. Here's a minimal example: @@ -803,7 +803,6 @@ env: DEVELOCITY_INJECTION_ENABLED: true DEVELOCITY_URL: https://develocity.your-server.com DEVELOCITY_PLUGIN_VERSION: 3.16.1 - DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }} # Required to publish scans to develocity.gradle.org jobs: build: @@ -816,10 +815,11 @@ jobs: run: ./gradlew build ``` -This configuration will automatically apply `v3.16.1` of the [Develocity Gradle plugin](https://docs.gradle.com/enterprise/gradle-plugin/), and publish build scans to https://develocity.gradle.org. +This configuration will automatically apply `v3.16.1` of the [Develocity Gradle plugin](https://docs.gradle.com/enterprise/gradle-plugin/), and publish build scans to https://develocity.your-server.com. -Note that the `develocity.gradle.org` server requires authentication in order to publish scans. The provided `DEVELOCITY_ACCESS_KEY` isn't required by the Develocity injection script, -but will be used by the GE plugin in order to authenticate with the server. +This example assumes that the `develocity.your-server.com` server allows anonymous publishing of build scans. +In the likely scenario that your Develocity server requires authentication, you will also need to configure an addition environment variable +with a valid [Develocity access key](https://docs.gradle.com/enterprise/gradle-plugin/#via_environment_variable). ## Configuring Develocity injection