gradle/gradle-build-action
1
0
Fork 0
mirror of https://github.com/gradle/gradle-build-action.git synced 2025-04-04 20:34:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update Develocity injection example in README

Browse source 
- 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`)
This commit is contained in:
daz 2024-01-10 19:15:48 -07:00
parent de611a6678
commit c8a1bc36ae
No known key found for this signature in database
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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