This repository is maintained by the Develocity Solutions team, as one of several publicly available repositories:
The sbt Develocity Common Custom User Data plugin enhances published build scans by adding a set of tags, links and custom values that have proven to be useful for many projects building with Develocity.
You can leverage this plugin for your project in one of two ways:
- Apply the published plugin directly in your build and immediately benefit from enhanced build scans
- Copy this repository and develop a customized version of the plugin to standardize Develocity usage across multiple projects
The sbt Develocity Common Custom User Data plugin is available in the Maven Central. This plugin requires the sbt Develocity plugin to also be applied in your build in order to have an effect.
In order for the sbt Develocity Common Custom User Data plugin to become active, you need to add it in the project/plugins.sbt file of your project. The project/plugins.sbt file is the same
file where you have already declared the sbt Develocity plugin.
See here for an example.
This table details the version compatibility of the sbt Develocity Common Custom User Data plugin with the sbt Develocity plugin.
| sbt Develocity Common Custom User Data plugin (this) versions | sbt Develocity plugin versions | sbt versions |
|---|---|---|
| 1.0 | 1.0 | 1.6.0+ |
The additional tags, links and custom values captured by this plugin include:
- A tag representing the operating system
- A tag representing how the build was invoked, be that from your IDE (IDEA, Eclipse) or from the command-line
- A tag representing builds run on CI, together with a set of tags, links and custom values specific to the CI server running the build
- For Git repositories, information on the commit id, branch name, status, and whether the checkout is dirty or not
See CustomBuildScanEnhancements.scala for details on what data is captured and under which conditions.
This plugin also allows overriding various Develocity related settings via system properties and environment variables:
- Develocity general configuration
See Overrides.scala for the override behavior.
You can use the system properties and environment variables to override Develocity related settings temporarily without having to modify the build scripts. For example, to change the Develocity server when running a build:
sbt -Ddevelocity.url=https://ge.solutions-team.gradle.com/ runClick to see the complete set of available system properties and environment variables in the table below.
| Develocity API | System property | Environment variable |
|---|---|---|
| develocity.server | develocity.url | DEVELOCITY_URL |
| develocity.allowUntrustedServer | develocity.allowUntrustedServer | DEVELOCITY_ALLOWUNTRUSTEDSERVER |
For more flexibility, we recommend creating a copy of this repository so that you may develop a customized version of the plugin and publish it internally for your projects to consume.
This approach has a number of benefits:
- Tailor the build scan enhancements to exactly the set of tags, links and custom values you require
- Standardize the configuration for connecting to Develocity and the remote build cache in your organization, removing the need for each project to specify this configuration
If your customized plugin provides all required Develocity configuration, then a consumer project will get all the benefits of Develocity simply by applying the plugin. The project sources provide a good template to get started with your own plugin.
Refer to the Javadoc for more details on the key types available for use.
Refer to the release history to see detailed changes on the versions.
Visit our website to learn more about Develocity.
The sbt Develocity Common Custom User Data plugin is open-source software released under the Apache 2.0 License.