Develocity Gradle Plugin

https://docs.gradle.com/develocity/gradle/4.4/
Admin
Develocity Gradle Plugin enables build optimization through Build Scans for detailed build insights...
Tokens:18,067
Snippets:252
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Apply Develocity Plugin in Root build.gradle.kts (Older Gradle)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Example of applying the Develocity plugin in a root build.gradle.kts file for older Gradle versions.

```kotlin
plugins {
    id("com.gradle.develocity").version("4.4.1")
}
```

--------------------------------

### Apply Develocity Plugin in Root build.gradle (Older Gradle)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Example of applying the Develocity plugin in a root build.gradle file for older Gradle versions.

```groovy
plugins {
    id "com.gradle.develocity" version "4.4.1"
}
```

--------------------------------

### Capture Expensive Git Commit ID in Background (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `background()` method to capture expensive data, like the Git commit ID, without slowing down the build. This Groovy example executes the git command directly.

```groovy
develocity {
    buildScan {
        background {
            def commitId = "git rev-parse --verify HEAD".execute().text.trim()
            value "Git Commit ID", commitId
        }
    }
}
```

--------------------------------

### Configure Develocity Server and Build Scan Settings (settings.gradle.kts)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity server URL and build scan settings within the settings.gradle.kts file.

```kotlin
develocity {
    server.set("https://develocity.example.com")
    buildScan {
        // tags and other settings
    }
}
```

--------------------------------

### Download and Verify Plugin Jar Signature

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use curl to download the plugin JAR and its signature, then use GPG to import the public key and verify the signature. The warning about the key not being trusted is expected if you haven't explicitly trusted it.

```shell
curl -OL https://plugins.gradle.org/m2/com/gradle/develocity-gradle-plugin/4.4.1/develocity-gradle-plugin-4.4.1.jar && \
  curl -OL https://plugins.gradle.org/m2/com/gradle/develocity-gradle-plugin/4.4.1/develocity-gradle-plugin-4.4.1.jar.asc && \
  gpg --keyserver keys.openpgp.org --recv-key 7B79ADD11F8A779FE90FD3D0893A028475557671 && \
  gpg --verify develocity-gradle-plugin-4.4.1.jar.asc develocity-gradle-plugin-4.4.1.jar
```

--------------------------------

### Configure Develocity Server and Build Scan Settings (settings.gradle)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity server URL and build scan settings within the settings.gradle file.

```groovy
develocity {
    server = "https://develocity.example.com"
    buildScan {
        // tags and other settings
    }
}
```

--------------------------------

### Configure Access Key via settings.gradle

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set the Develocity server URL and access key directly in the `settings.gradle` file using Groovy DSL.

```groovy
develocity {
    server = "https://develocity.example.com"
    accessKey = "7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq"
}
```

--------------------------------

### Configure Access Key via Environment Variable (Multiple Servers)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Specify access keys for multiple Develocity servers by separating entries with semicolons in the `DEVELOCITY_ACCESS_KEY` environment variable.

```shell
export DEVELOCITY_ACCESS_KEY=ge1.example.com=7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq;ge2.example.com=9y4agfiubqqjea4vonghohvuyra5bnvszop4asbqee3m3sm67w5k && \
  ./gradlew build
```

--------------------------------

### Configure Access Key via Environment Variable (Single Server)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set the `DEVELOCITY_ACCESS_KEY` environment variable for CI environments. The format is `«server host name»=«access key»`.

```shell
export DEVELOCITY_ACCESS_KEY=develocity.example.com=7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq && \
  ./gradlew build
```

--------------------------------

### Configure Access Key via settings.gradle.kts

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set the Develocity server URL and access key directly in the `settings.gradle.kts` file using Kotlin DSL.

```kotlin
develocity {
    server.set("https://develocity.example.com")
    accessKey.set("7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq")
}
```

--------------------------------

### Agree to Develocity Terms of Service in Groovy

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure your build script in Groovy to agree to the terms of service for publishing Build Scans to Develocity at gradle.com. This avoids interactive prompts.

```groovy
develocity {
    buildScan {
        termsOfUseUrl = "https://gradle.com/help/legal-terms-of-use"
        termsOfUseAgree = "yes"
    }
}
```

--------------------------------

### Agree to Develocity Terms of Service in Kotlin

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure your build script in Kotlin to agree to the terms of service for publishing Build Scans to Develocity at gradle.com. This avoids interactive prompts.

```kotlin
develocity {
    buildScan {
        termsOfUseUrl.set("https://gradle.com/help/legal-terms-of-use")
        termsOfUseAgree.set("yes")
    }
}
```

--------------------------------

### Configure Develocity Build Cache Connector (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register the Develocity Build Cache connector and configure the Develocity server URL in your `settings.gradle`.

```groovy
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        // configure
    }
}
```

--------------------------------

### Provision Develocity Access Key

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Execute the Gradle task to automatically provision a Develocity access key. This task opens a browser for authentication and stores the key in `develocity/keys.properties`.

```shell
./gradlew provisionDevelocityAccessKey
```

--------------------------------

### Configure Build Cache with Username and Password (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Authenticate with the Develocity Build Cache using username and password credentials in `settings.gradle`.

```groovy
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        usernameAndPassword("user", "pass")
    }
}
```

--------------------------------

### Configure Access Key via properties file

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Store Develocity access keys in the `keys.properties` file within the Gradle user home directory. The property name should be the server hostname.

```properties
develocity.example.com=7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq
```

--------------------------------

### Set Resource Usage Capture via GRADLE_OPTS

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure resource usage capturing by setting the `scan.capture-resource-usage` system property in the `GRADLE_OPTS` environment variable.

```shell
export GRADLE_OPTS="-Dscan.capture-resource-usage=false"
```

--------------------------------

### Create a Develocity Access Token using CURL

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use this CURL command to create a short-lived access token for Develocity. Specify desired permissions, project IDs, and expiration time. The token is valid only for the Develocity instance that created it.

```shell
curl -X POST https://ge.example.com/api/auth/token?permissions=publishScan,writeCache,accessDataWithoutAssociatedProject&projectIds=project-a,project-b&expiresInHours=1 \
  -H "Authorization: Bearer 7asejatf24zun43yshqufp7qi4ovcefxpykbwzqbzilcpwzb52ja"
```

```json
eyJraWQiOiJ0ZXN0LWtleSIsImFsZyI6IlJTMjU2IiwidHlwIjoiSldUIn0.eyJpc19hbm9ueW1vdXMiOmZhbHNlLCJwZXJtaXNzaW9ucyI6WyJSRUFEX1ZFUlNJT04iLCJFWFBPUlRfREFUQSIsIkFDQ0VTU19EQVRBX1dJVEhPVVRfQVNTT0NJQVRFRF9QUk9KRUNUIl0sInByb2plY3RzIjp7ImEiOjEsImIiOjJ9LCJ1c2VyX2lkIjoic29tZS1pZCIsInVzZXJuYW1lIjoidGVzdCIsImZpcnN0X25hbWUiOiJhIiwibGFzdF9uYW1lIjoidXNlciIsImVtYWlsIjoiYkBncmFkbGUuY29tIiwic3ViIjoidGVzdCIsImV4cCI6NzIwMCwibmJmIjowLCJpYXQiOjAsImF1ZCI6ImV4YW1wbGUuZ3JhZGxlLmNvbSIsImlzcyI6ImV4YW1wbGUuZ3JhZGxlLmNvbSIsInRva2VuX3R5cGUiOiJhY2Nlc3NfdG9rZW4ifQ.H1_NEG1xuleP-WIAY_uvSmdd2o7i_-Ko3qhlo04zvCgrElJe7_F5jNuqsyDfnb5hvKlOe5UKG_7QPTgY9-3pFQ
```

--------------------------------

### Configure Non-Built-In Cache Server with Untrusted Server Option

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure a non-built-in Develocity Build Cache server and bypass certificate warnings using the `allowUntrustedServer` option. This is a workaround for evaluation and should not be used in production due to security risks.

```gradle
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        server = "https://develocity-cache-1.example.com"
        allowUntrustedServer = true
    }
}
```

```gradle
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        server = "https://develocity-cache-1.example.com"
        allowUntrustedServer = true
    }
}
```

--------------------------------

### Configure Develocity Build Cache Connector (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register the Develocity Build Cache connector and configure the Develocity server URL in your `settings.gradle.kts`.

```kotlin
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        // configure
    }
}
```

--------------------------------

### Configure Build Cache with Username and Password (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Authenticate with the Develocity Build Cache using username and password credentials in `settings.gradle.kts`.

```kotlin
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        usernameAndPassword("user", "pass")
    }
}
```

--------------------------------

### Configure Develocity Server Connection (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity server URL using Groovy DSL. This is required to connect to your Develocity instance.

```groovy
develocity {
    server = "https://develocity.example.com"
}
```

--------------------------------

### Add VCS URL to Build Scan (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Attach a link to an online VCS repository pointing to a specific branch. The branch is provided as a system property.

```kotlin
develocity {
    buildScan {
        link("VCS", "https://github.com/myorg/sample/tree/${System.getProperty("vcs.branch")}")
    }
}
```

--------------------------------

### Add Custom Disk Usage Value at Build End (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `buildFinished()` hook to attach custom data that is only available after the build has completed, such as the size of the output directory.

```groovy
develocity {
    buildScan {
        buildFinished {
            value "Disk usage (output dir)", buildDir.directorySize().toString()
        }
    }
}
```

--------------------------------

### Add VCS URL to Build Scan (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Attach a link to an online VCS repository pointing to a specific branch. The branch is provided as a system property.

```groovy
develocity {
    buildScan {
        link "VCS", "https://github.com/myorg/sample/tree/${System.getProperty("vcs.branch")}"
    }
}
```

--------------------------------

### Inject Custom Link via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use '-Dscan.link.<label>=<URL>' to add a link to a Build Scan. This can be used to associate external resources, like VCS commits or documentation, with a scan.

```shell
./gradlew build -Dscan.link.VCS=https://github.com/myorg/my-super-project/tree/my-new-feature
```

--------------------------------

### Configure On-Demand Build Scan Publishing

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use this configuration to publish Build Scans only when explicitly requested via the `--scan` argument.

```kotlin
develocity {
    buildScan {
        publishing.onlyIf { false }
    }
}
```

```groovy
develocity {
    buildScan {
        publishing.onlyIf { false }
    }
}
```

--------------------------------

### Enable Writing to Build Cache (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity Build Cache connector to write entries to the cache by setting `push` to `true` in `settings.gradle`.

```groovy
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        push = true
    }
}
```

--------------------------------

### Apply Develocity Plugin in Gradle 5.x (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4

Apply the Develocity Gradle plugin to the root project for Gradle 5.x using Kotlin DSL. Configuration is done via the `develocity` extension.

```kotlin
plugins {
     id("com.gradle.develocity").version("4.4.1")
}

develocity {
    // configuration
}
```

--------------------------------

### Configure Develocity Server Connection (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity server URL using Kotlin DSL. This is required to connect to your Develocity instance.

```kotlin
develocity {
    server.set("https://develocity.example.com")
}
```

--------------------------------

### Add Custom Disk Usage Value at Build End (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `buildFinished()` hook to attach custom data that is only available after the build has completed, such as the size of the output directory.

```kotlin
develocity {
    buildScan {
        buildFinished {
            value("Disk usage (output dir)", buildDir.walkTopDown().map { it.length() }.sum().toString())
        }
    }
}
```

--------------------------------

### Publish Previous Build Scan

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `buildScanPublishPrevious` task to publish a Build Scan for the most recently executed build.

```shell
./gradlew buildScanPublishPrevious
```

```shell
./gradlew bSPP
```

--------------------------------

### Set Resource Usage Capture in gradle.properties

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure resource usage capturing by setting the `scan.capture-resource-usage` system property in a `gradle.properties` file.

```properties
systemProp.scan.capture-resource-usage=false
```

--------------------------------

### Enable Writing to Build Cache (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity Build Cache connector to write entries to the cache by setting `isPush` to `true` in `settings.gradle.kts`.

```kotlin
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        isPush = true
    }
}
```

--------------------------------

### Apply Develocity Plugin in Gradle 6.x+ (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4

Apply the Develocity Gradle plugin in the settings file for Gradle 6.x and later using Groovy DSL. Configuration is done via the `develocity` extension.

```groovy
plugins {
    id "com.gradle.develocity" version "4.4.1"
}

develocity {
    // configuration
}
```

--------------------------------

### Configure Remote Build Cache (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4

Add this to your `settings.gradle` to configure the remote Develocity Build Cache. Disables local cache for visibility and enables push.

```groovy
buildCache {
  local {
    enabled = false __**(1)**
  }
  remote(develocity.buildCache) {
    server = "https://develocity.example.com" __**(2)**
    path = "/cache/" __**(3)**
    push = true __**(4)**
  }
}
```

--------------------------------

### Log Build Scan Details in Kotlin

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure a callback in your build script to log the Build Scan ID and URI to a file after a scan is published. This helps maintain a journal of created scans.

```kotlin
import java.util.Date

develocity {
    buildScan {
        buildScanPublished {
            file("scan-journal.log").appendText("${Date()} - ${this.buildScanId} - ${this.buildScanUri}\n")
        }
    }
}
```

--------------------------------

### Enable HTTP Expect-Continue for Develocity Build Cache

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity Build Cache client to use HTTP Expect-Continue. This is suitable for servers that may redirect or reject PUT requests, preventing unnecessary data transmission. Ensure your Build Cache server reliably supports this feature before enabling.

```gradle
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        useExpectContinue = true
    }
}
```

```gradle
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        useExpectContinue = true
    }
}
```

--------------------------------

### Add Tags to Build Scans Programmatically (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Add conditional and environment-based tags to build scans programmatically using Kotlin.

```kotlin
develocity {
    buildScan {
        tag(if (System.getenv("CI").isNullOrEmpty()) "Local" else "CI")
        tag(System.getProperty("os.name"))
    }
}
```

--------------------------------

### Log Build Scan Details in Groovy

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure a callback in your build script to log the Build Scan ID and URI to a file after a scan is published. This helps maintain a journal of created scans.

```groovy
import com.gradle.scan.plugin.PublishedBuildScan

develocity {
    buildScan {
        buildScanPublished { PublishedBuildScan scan ->
            file("scan-journal.log") << "${new Date()} - ${scan.buildScanId} - ${scan.buildScanUri}\n"
        }
    }
}
```

--------------------------------

### Configure Basic Test Retry Settings

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Enable test retry and set the maximum number of retries, maximum failures before disabling retries, and whether to fail the task on passed retries. Use this to control the overall test retry behavior.

```kotlin
tasks.test {
    develocity.testRetry {
        maxRetries.set(3)
        maxFailures.set(20)
        failOnPassedAfterRetry.set(true)
    }
}
```

```groovy
tasks.named('test', Test) {
    develocity.testRetry {
        maxRetries = 3
        maxFailures = 20
        failOnPassedAfterRetry = true
    }
}
```

--------------------------------

### Configure Develocity Server URL via Gradle Properties

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set the Develocity server URL using the 'com.gradle.develocity.url' property in your gradle.properties file. This has lower precedence than the CLI argument.

--------------------------------

### Create Access Token

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

This endpoint allows you to create short-lived access tokens. You can specify permissions, project IDs, and the token's lifetime. The token created will have the same or fewer permissions and a shorter or equal lifetime than the credentials used for authentication.

```APIDOC
## POST /api/auth/token

### Description
Creates a short-lived access token for authentication with Develocity.

### Method
POST

### Endpoint
/api/auth/token

### Parameters
#### Query Parameters
- **permissions** (string) - Optional - The config values of each permission you want to grant. Can be a comma-separated list or repeated parameter.
- **projectIds** (string) - Optional - The ID of each project you want to grant access to. Can be a comma-separated list or repeated parameter.
- **expiresInHours** (integer) - Optional - The token's intended lifetime in hours, with a maximum of 24. Defaults to two hours or the remaining lifetime of the credential used to authenticate the request, whichever is smaller.

### Request Example
```bash
curl -X POST https://ge.example.com/api/auth/token?permissions=publishScan,writeCache,accessDataWithoutAssociatedProject&projectIds=project-a,project-b&expiresInHours=1 \
  -H "Authorization: Bearer 7asejatf24zun43yshqufp7qi4ovcefxpykbwzqbzilcpwzb52ja"
```

### Response
#### Success Response (200)
- **access_token** (string) - The generated short-lived access token.

#### Response Example
```json
{
  "access_token": "eyJraWQiOiJ0ZXN0LWtleSIsImFsZyI6IlJTMjU2IiwidHlwIjoiSldUIn0.eyJpc19hbm9ueW1vdXMiOmZhbHNlLCJwZXJtaXNzaW9ucyI6WyJSRUFEX1ZFUlNJT04iLCJFWFBPUlRfREFUQSIsIkFDQ0VTU19EQVRBX1dJVEhPVVRfQVNTT0NJQVRFRF9QUk9KRUNUIl0sInByb2plY3RzIjp7ImEiOjEsImIiOjJ9LCJ1c2VyX2lkIjoic29tZS1pZCIsInVzZXJuYW1lIjoidGVzdCIsImZpcnN0X25hbWUiOiJhIiwibGFzdF9uYW1lIjoidXNlciIsImVtYWlsIjoiYkBncmFkbGUuY29tIiwic3ViIjoidGVzdCIsImV4cCI6NzIwMCwibmJmIjowLCJpYXQiOjAsImF1ZCI6ImV4YW1wbGUuZ3JhZGxlLmNvbSIsImlzcyI6ImV4YW1wbGUuZ3JhZGxlLmNvbSIsInRva2VuX3R5cGUiOiJhY2Nlc3NfdG9rZW4ifQ.H1_NEG1xuleP-WIAY_uvSmdd2o7i_-Ko3qhlo04zvCgrElJe7_F5jNuqsyDfnb5hvKlOe5UKG_7QPTgY9-3pFQ"
}
```

### Error Handling
- **403 Forbidden**: If the user creating the token doesn’t have one of the requested permissions or projects, or if the requested lifetime exceeds the lifetime of the authentication credential.
```

--------------------------------

### Expected GPG Verification Output

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

This output indicates a good signature, confirming the JAR was signed with the correct private key. The 'unknown' status for the key's trust is normal if the key hasn't been explicitly trusted.

```text
gpg: Signature made Thu Sep 28 16:17:46 2023 CEST
gpg:                using RSA key 893A028475557671
gpg: Good signature from "Gradle Inc. <info@gradle.com>" [unknown]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 7B79 ADD1 1F8A 779F E90F  D3D0 893A 0284 7555 7671
```

--------------------------------

### Add Tags to Build Scans Programmatically (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Add conditional and environment-based tags to build scans programmatically using Groovy.

```groovy
develocity {
    buildScan {
        if (System.getenv("CI")) {
            tag "CI"
        } else {
            tag "Local"
        }

        tag System.getProperty("os.name")
    }
}
```

--------------------------------

### Apply Develocity Plugin in Gradle 6.x+ (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4

Apply the Develocity Gradle plugin in the settings file for Gradle 6.x and later using Kotlin DSL. Configuration is done via the `develocity` extension.

```kotlin
plugins {
    id("com.gradle.develocity") version("4.4.1")
}

develocity {
    // configuration
}
```

--------------------------------

### Inject Custom Value via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use '-Dscan.value.<key>=<value>' to inject arbitrary key-value pairs into a Build Scan. This is helpful for storing specific build-related information.

```shell
./gradlew build "-Dscan.value.CIBuildType=QA_Build"
```

--------------------------------

### Configure Remote Build Cache (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4

Add this to your `settings.gradle.kts` to configure the remote Develocity Build Cache. Disables local cache for visibility and enables push.

```kotlin
buildCache {
  local {
    isEnabled = false __**(1)**
  }
  remote(develocity.buildCache) {
    server = "https://develocity.example.com" __**(2)**
    path = "/cache/" __**(3)**
    isPush = true __**(4)**
  }
}
```

--------------------------------

### Publish Build Scan to Specific Develocity Server via CLI

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use this CLI parameter to publish a Build Scan to a specific Develocity server without modifying your Gradle project. This method has the highest precedence.

```shell
./gradlew assemble --develocity-url https://develocity.example.com
```

--------------------------------

### Workaround for Slow Hostname Resolution on macOS

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Add these lines to your /etc/hosts file to resolve slow hostname resolution issues on macOS. Substitute 'mbpro' with your computer's name.

```bash
./etc/hosts
127.0.0.1   localhost mbpro.local
::1         localhost mbpro.local
```

--------------------------------

### Inject Custom Tag via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use '-Dscan.tag.<tag>' to add a tag to a Build Scan. This is useful for categorizing scans, such as marking them as originating from CI.

```shell
./gradlew build -Dscan.tag.CI
```

--------------------------------

### Combine Build Scan Publishing Criteria

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use an `if` condition to combine multiple criteria for publishing Build Scans, such as tagging CI builds.

```kotlin
develocity {
    buildScan {
        if (!System.getenv("CI").isNullOrEmpty()) {
            publishing.onlyIf { true }
            tag("CI")
        }
    }
}
```

```groovy
develocity {
    buildScan {
        if (System.getenv("CI")) {
            publishing.onlyIf { true }
            tag "CI"
        }
    }
}
```

--------------------------------

### Set Project Identifier via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set the `develocity.projectId` system property to specify a project identifier. This setting takes precedence over programmatic configuration.

```shell
./gradlew build -Ddevelocity.projectId=myProject
```

```shell
export GRADLE_OPTS=-Ddevelocity.projectId=myProject
```

```properties
systemProp.develocity.projectId=myProject
```

--------------------------------

### Configure Remote Build Cache with Untrusted SSL (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4

Configure the remote Develocity Build Cache in `settings.gradle.kts`, allowing untrusted SSL certificates for development or specific environments.

```kotlin
buildCache {
  local {
    isEnabled = false
  }
  remote(develocity.buildCache) {
    server = "https://develocity.example.com"
    path = "/cache/"
    isPush = true
    allowUntrustedServer = true
  }
}
```

--------------------------------

### Disable Build Scan Upload via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Disable background uploading by setting the `scan.uploadInBackground` system property to `false`. This setting takes precedence over programmatic configuration.

```shell
./gradlew build -Dscan.uploadInBackground=false
```

```shell
export GRADLE_OPTS=-Dscan.uploadInBackground=false
```

```properties
systemProp.scan.uploadInBackground=false
```

--------------------------------

### Configure Remote Build Cache with Untrusted SSL (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4

Configure the remote Develocity Build Cache in `settings.gradle`, allowing untrusted SSL certificates for development or specific environments.

```groovy
buildCache {
  local {
    enabled = false
  }
  remote(develocity.buildCache) {
    server = "https://develocity.example.com"
    path = "/cache/"
    push = true
    allowUntrustedServer = true
  }
}
```

--------------------------------

### Specify Develocity Plugin Version via CLI

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity plugin version to use via a CLI parameter. This is useful if you need a version different from the default. The minimum supported version is 4.4.0.

```shell
./gradlew assemble --develocity-url https://develocity.example.com --develocity-plugin-version 4.4.1
```

--------------------------------

### Allow Untrusted SSL Communication (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity plugin to allow untrusted SSL certificates for the Develocity server using Groovy DSL. Use with caution as it poses a security risk.

```groovy
develocity {
    server = "https://develocity.example.com"
    allowUntrustedServer = true
}
```

--------------------------------

### Allow Untrusted SSL Communication (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity plugin to allow untrusted SSL certificates for the Develocity server using Kotlin DSL. Use with caution as it poses a security risk.

```kotlin
develocity {
    server.set("https://develocity.example.com")
    allowUntrustedServer.set(true)
}
```

--------------------------------

### Configure Test Retries for CI Builds (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Enable test retries with specific configurations only when running in a CI environment. This prevents unnecessary retries during local development.

```groovy
boolean isCiServer = System.getenv().containsKey("CI")
tasks.named('test', Test) {
    develocity.testRetry {
        if (isCiServer) {
            maxRetries = 3
            maxFailures = 20
            failOnPassedAfterRetry = true
        }
    }
}
```

--------------------------------

### Conditionally Disable Build Scan Upload in Background (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Conditionally disable background uploading based on environment variables using `System.getenv()` in the `develocity.buildScan` block.

```kotlin
develocity {
    buildScan {
        uploadInBackground.set(System.getenv("CI") == null)
    }
}
```

--------------------------------

### Conditionally Disable Build Scan Upload in Background (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Conditionally disable background uploading based on environment variables using `System.getenv()` in the `develocity.buildScan` block.

```groovy
develocity {
    buildScan {
        uploadInBackground = System.getenv("CI") == null
    }
}
```

--------------------------------

### Trigger On-Demand Build Scan Publication

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Append the `--scan` argument to any Gradle command to trigger the publication of a Build Scan when on-demand publishing is enabled.

```shell
./gradlew assemble --scan
```

--------------------------------

### Capture Expensive Git Commit ID in Background (Kotlin, Gradle 5.x)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `background()` method to capture expensive data, like the Git commit ID, without slowing down the build. This version is for Gradle 5.x.

```kotlin
import java.io.ByteArrayOutputStream
...
develocity {
    buildScan {
        background {
            val os = ByteArrayOutputStream()
            exec {
                commandLine("git", "rev-parse", "--verify", "HEAD")
                standardOutput = os
            }
            value("Git Commit ID", os.toString())
        }
    }
}
```

--------------------------------

### Configure Test Retries for CI Builds (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Enable test retries with specific configurations only when running in a CI environment. This prevents unnecessary retries during local development.

```kotlin
val isCiServer = System.getenv().containsKey("CI")
tasks.test {
    develocity.testRetry {
        if (isCiServer) { 
            maxRetries.set(3)
            maxFailures.set(20)
            failOnPassedAfterRetry.set(true)
        }
    }
}
```

--------------------------------

### Obfuscate Hostnames in Kotlin

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register a function to convert hostname characters to their numeric values and join them with hyphens for obfuscation. Use this with Kotlin DSL.

```kotlin
develocity {
    buildScan {
        obfuscation {
            hostname { host -> host.toCharArray().map { character -> Character.getNumericValue(character) }.joinToString("-") }
        }
    }
}
```

--------------------------------

### Use Gradle's Built-In HTTP Connector for Develocity Build Cache

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity Build Cache using Gradle's generic HTTP Build Cache connector. This is an alternative when the Develocity-specific connector cannot be used. Note that username/password authentication is only supported by Develocity Build Cache up to version 2024.2.

```gradle
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(HttpBuildCache::class) {
        url = uri("https://develocity.example.com/cache/")
    }
}
```

```gradle
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(HttpBuildCache) {
        url = 'https://develocity.example.com/cache/'
    }
}
```

--------------------------------

### Disable Build Scan Upload in Background (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set `uploadInBackground` to `false` in the `develocity.buildScan` block to disable background uploading of build scans.

```groovy
develocity {
    buildScan {
        uploadInBackground = false
    }
}
```

--------------------------------

### Enforce Publishing Build Scan for Every Build (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Explicitly enforce the default behavior of publishing a Build Scan for every build execution using Kotlin DSL. This ensures consistent tracking of build behavior and performance.

```kotlin
develocity {
    buildScan {
        publishing.onlyIf { true }
    }
}
```

--------------------------------

### Inject Dynamic Value via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Inject dynamic values, such as CI build numbers, into Build Scans using system properties. Ensure the environment variable is correctly set in your CI system.

```shell
./gradlew build "-Dscan.value.buildNumber=$CI_BUILD_NUMBER"
```

--------------------------------

### Disable Resource Usage Capturing via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Disable resource usage capturing by setting the `scan.capture-resource-usage` system property to `false` when invoking Gradle.

```shell
./gradlew build -Dscan.capture-resource-usage=false
```

--------------------------------

### Disable Build and Test Output Capture via System Property

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Disable capturing of build and test outputs by setting the 'scan.capture-build-logging' and 'scan.capture-test-logging' system properties to 'false'. This can be done via command line, environment variables, or gradle.properties.

```shell
./gradlew build -Dscan.capture-build-logging=false -Dscan.capture-test-logging=false
```

```shell
export GRADLE_OPTS="-Dscan.capture-build-logging=false -Dscan.capture-test-logging=false"
```

```properties
systemProp.scan.capture-build-logging=false
systemProp.scan.capture-test-logging=false
```

--------------------------------

### Obfuscate Hostnames in Groovy

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register a function to convert hostname characters to their numeric values and join them with hyphens for obfuscation. Use this with Groovy DSL.

```groovy
develocity {
    buildScan {
        obfuscation {
            hostname { host -> host.collect { character -> Character.getNumericValue(character as char) }.join("-") }
        }
    }
}
```

--------------------------------

### Configure Non-Built-In Develocity Build Cache Server

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Configure the Develocity Gradle plugin to use a separately deployed Build Cache node. This is useful for geographical distribution and horizontal scaling. The server address should be specified without any request path component.

```gradle
develocity {
    server.set("https://develocity.example.com")
}

buildCache {
    remote(develocity.buildCache) {
        server = "https://develocity-cache-1.example.com"
    }
}
```

```gradle
develocity {
    server = "https://develocity.example.com"
}

buildCache {
    remote(develocity.buildCache) {
        server = "https://develocity-cache-1.example.com"
    }
}
```

--------------------------------

### Capture Expensive Git Commit ID in Background (Kotlin, Gradle 6.2+)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `background()` method to capture expensive data, like the Git commit ID, without slowing down the build. This version is compatible with Gradle 6.2+ and Configuration Cache.

```kotlin
import org.gradle.kotlin.dsl.support.serviceOf
import java.io.ByteArrayOutputStream
...

develocity {
  buildScan {
    val execOps = serviceOf<ExecOperations>()
    background {
      val os = ByteArrayOutputStream()
      execOps.exec {
        commandLine("git", "rev-parse", "--verify", "HEAD")
        standardOutput = os
      }
      value("Git Commit ID", os.toString())
    }
  }
}
```

--------------------------------

### Disable Build Scan Upload in Background (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Set `uploadInBackground` to `false` in the `develocity.buildScan` block to disable background uploading of build scans.

```kotlin
develocity {
    buildScan {
        uploadInBackground.set(false)
    }
}
```

--------------------------------

### Add Custom Value to Build Scan (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Attach a custom key-value pair to Build Scans, useful for adding context to build information like build numbers.

```groovy
develocity {
    buildScan {
        value "Build Number", project.buildNumber
    }
}
```

--------------------------------

### Disable SSL Certificate Checks (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4

Configure Develocity to allow untrusted server certificates using Groovy DSL. This is a workaround and not recommended for long-term use.

```groovy
buildScan {
    server = '...'
    allowUntrustedServer = true
}
```

--------------------------------

### Obfuscate External Process Names in Groovy (Plugin 3.18+)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register a function to replace non-build-related external process names with a generic string for obfuscation. Use this with Groovy DSL.

```groovy
develocity {
    buildScan {
        obfuscation {
            externalProcessName { processName -> 'non-build-process' }
        }
    }
}
```

--------------------------------

### Obfuscate External Process Names in Kotlin (Plugin 3.18+)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register a function to replace non-build-related external process names with a generic string for obfuscation. Use this with Kotlin DSL.

```kotlin
develocity {
    buildScan {
        obfuscation {
            externalProcessName { processName -> "non-build-process" }
        }
    }
}
```

--------------------------------

### Check Build Status from buildFinished() (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Access the `BuildResult` within the `buildFinished()` hook to conditionally add data to the Build Scan, such as failure messages.

```groovy
import com.gradle.scan.plugin.BuildResult

develocity {
    buildScan {
        buildFinished { BuildResult result ->
            if (result.failures) {
                value "Failed with", result.failures.message.join(", ")
            }
        }
    }
}
```

--------------------------------

### Add Custom Value to Build Scan (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Attach a custom key-value pair to Build Scans, useful for adding context to build information like build numbers.

```kotlin
develocity {
    buildScan {
        value("Build Number", project.buildNumber)
    }
}
```

--------------------------------

### Obfuscate IP Addresses in Kotlin

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Register a function to replace all IP addresses with '0.0.0.0' for obfuscation. Use this with Kotlin DSL.

```kotlin
develocity {
    buildScan {
        obfuscation {
            ipAddresses { addresses -> addresses.map { _ -> "0.0.0.0" } }
        }
    }
}
```

--------------------------------

### Disable Resource Usage Capturing Programmatically (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Use the `buildScan` extension to programmatically disable resource usage capturing in Groovy.

```groovy
develocity {
    buildScan {
        capture {
            resourceUsage = false
        }
    }
}
```

--------------------------------

### Disable SSL Certificate Checks (Kotlin)

Source: https://docs.gradle.com/develocity/gradle/4.4

Configure Develocity to allow untrusted server certificates using Kotlin DSL. This is a workaround and not recommended for long-term use.

```kotlin
develocity {
    server.set("...")
    allowUntrustedServer.set(true)
}
```

--------------------------------

### Configure Class-Level Test Retrying

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Enable retrying of entire test classes as a unit, based on class name or annotation filters. This ensures that if one test in a class fails, the entire class is retried.

```kotlin
tasks.test {
    develocity.testRetry {
        maxRetries.set(3)
        classRetry {
            // configure by qualified class name (* matches zero or more of any character)
            includeClasses.add("*StepWiseIntegrationTest")

            // configure by class level annotations
            // Note: @Inherited annotations are respected
            includeAnnotationClasses.add("*ClassRetry")
        }
    }
}
```

```groovy
tasks.named('test', Test) {
    develocity.testRetry {
        maxRetries = 3
        classRetry {
            // configure by qualified class name (* matches zero or more of any character)
            includeClasses.add("*StepWiseIntegrationTest")

            // configure by class level annotations
            // Note: @Inherited annotations are respected
            includeAnnotationClasses.add("*ClassRetry")
        }
    }
}
```

--------------------------------

### Disable Build and Test Output Logging Programmatically (Groovy)

Source: https://docs.gradle.com/develocity/gradle/4.4/gradle-plugin

Disable capturing of build and test outputs by setting 'buildLogging' and 'testLogging' to false within the 'develocity.buildScan.capture' block in Groovy.

```groovy
develocity {
    buildScan {
        capture {
            buildLogging = false
            testLogging = false
        }
    }
}
```
Tokens:
Raw