Jenkins


Prerequisites
  • The Develocity plugin or extension is configured in your build. See the documentation for Gradle, Maven, sbt, npm, or Python.

  • You have a Develocity server URL and access key.

  • Jenkins administrator access to install plugins and manage credentials.

Install the Gradle Jenkins Plugin

Install the Gradle Jenkins plugin from the Jenkins Plugin Manager.

The plugin prominently displays Build Scan links for any Gradle or Maven build. It also instruments all CI jobs and configures the Develocity Gradle plugin or Maven extension centrally, without modifying individual projects.

For the full configuration guide, see the Gradle Jenkins plugin README.

Store the Access Key as a Credential

Store your Develocity access key in Jenkins as a Secret text credential under Manage JenkinsCredentials.

The access key value uses the format «server host name»=«access key»:

develocity.example.com=7w5kbqqjea4vonghohvuyra5bnvszop4asbqee3m3sm6dbjdudtq

Reference the credential in your Jenkinsfile using the withCredentials step so the access key is available as the DEVELOCITY_ACCESS_KEY environment variable during the build:

withCredentials([string(credentialsId: 'develocity-access-key', variable: 'DEVELOCITY_ACCESS_KEY')]) { (1)
    sh './gradlew build'
}
1 Replace develocity-access-key with the credential ID you chose when creating the credential in Jenkins.

Verify the Integration

After your first pipeline run, the Gradle Jenkins plugin displays a direct link to the Build Scan from the Jenkins build page. Open your Develocity server and navigate to Build Scan to confirm your build appears there. Install the Common Custom User Data plugin to tag builds as CI and enrich each Build Scan with the Git branch, commit SHA, and a link back to the Jenkins build.