A Build Scan is a representation of metadata captured as you run your build.

gradle basic 1

About Build Scan

Gradle captures your build metadata and sends it to the Build Scan Service. The service then transforms the metadata into information you can analyze and share with others.

build scan 1

The information that Build Scan collects can be an invaluable resource when troubleshooting, collaborating on, or optimizing the performance of your builds.

For example, with a Build Scan, it’s no longer necessary to copy and paste error messages or include all the details about your environment each time you want to ask a question on Stack Overflow, Slack, or the Gradle Forum. Instead, copy the link to your latest Build Scan.

build scan 2

Enable Build Scan

To enable a Build Scan on a Gradle command, add --scan to the command line option:

$ ./gradlew build --scan

You may be prompted to agree to the terms to use Build Scan.

Visit Develocity at gradle.com to learn more.

Publishing to a specific Develocity server

If you have a Develocity server, you can publish your Build Scan reports to that server instead of Develocity at gradle.com.

You enable this with the --develocity-url command line option:

 ./gradlew build --develocity-url=https://develocity.example.com

This triggers auto-application of the Develocity Gradle plugin if it is not already applied. Gradle auto-applies a default version of the plugin. To use a different version, add the --develocity-plugin-version command line option:

 ./gradlew build --develocity-url=https://develocity.example.com --develocity-plugin-version=4.5.0

The plugin version must be 4.4.0 or higher when a Develocity URL is specified. This option is only used when --develocity-url or --scan triggers auto-application of the plugin.

Both options can also be set with environment variables, which is convenient on CI where you do not control the command line:

$ export COM_GRADLE_DEVELOCITY_URL=https://develocity.example.com
$ export COM_GRADLE_DEVELOCITY_PLUGIN_VERSION=4.5.0
$ ./gradlew build --scan

The equivalent Gradle properties are com.gradle.develocity.url and com.gradle.develocity.plugin.version.

Check the Develocity Gradle plugin documentation for more details.

Captured Information

To see what data is captured and sent in a Build Scan, refer to the Captured Information section in the Gradle Develocity Plugin documentation.

Ready to build something? Start with the Beginner Tutorial.

Next Step: Start the Tutorial >>