Get started with Build Scan® for Gradle, Apache Maven™, and sbt

A Build Scan® is a shareable record of a build that provides insights into what happened and why. You can create a Build Scan at scans.gradle.com for the Gradle, Maven and sbt build tools for free.

Publishing a Build Scan to scans.gradle.com transmits information about your Gradle, Maven and sbt builds and their environment to Gradle's servers. The information is only accessible via a randomly generated link, printed at the end of the build. You can delete the Build Scan when you are finished.

A Build Scan that has not been viewed within 3 months of being created will be removed. Once a Build Scan has been viewed, it will be available indefinitely.

Develocity, our on-premises software, provides a version of the Build Scan service with additional features.

Build Scan® for Gradle
Gradle
Build Scan® for Maven
Maven
Build Scan® for sbt
sbt

Create a Build Scan® for Gradle in 30 seconds

Create a Build Scan® with the quickstart sample project, or follow the steps below with your project. Use of Build Scan® is subject to our Terms of Use. By publishing a Build Scan®, you agree to our Terms of Use.

Run your build with the --scan option.

gradle build --scan

1. Apply the plugin

Add this code snippet to the top of the build.gradle file of the root project, below any buildscript { … } sections if present. By adding this code snippet, you agree to our Terms of Use.

plugins { id 'com.gradle.build-scan' version '1.16' } buildScan { licenseAgreementUrl = 'https://gradle.com/terms-of-service' licenseAgree = 'yes' }

2. Run your build

Run your build with the --scan option.

gradle build --scan

Learn more

You can create a Build Scan for all of your builds via an init script. You can enable automatic publication. You can even extend each Build Scan with custom data, and more. Learn how via the Develocity Gradle Plugin User Manual.

Create a Build Scan® for Apache Maven™ in 30 seconds

Create a Build Scan® with the quickstart sample project, or follow the steps below with your project. Use of Build Scan® is subject to our Terms of Use. By publishing a Build Scan®, you agree to our Terms of Use.

1. Apply the extension

Execute the init goal to quickly set up the Develocity Maven extension on a Maven project. This requires the Develocity Maven extension version 1.19+.

mvn com.gradle:gradle-enterprise-maven-extension:1.20.1:init

2. Run your build

mvn install

1. Apply the extension

Declare the Develocity Maven extension in the .mvn/extensions.xml file in your root project.

<extensions> <extension> <groupId>com.gradle</groupId> <artifactId>gradle-enterprise-maven-extension</artifactId> <version>1.20.1</version> </extension> </extensions>

2. Run your build

mvn install

Learn more

You can even extend each Build Scan with custom data, and more. Learn how via the Develocity Maven Extension User Manual.

Create a Build Scan® for sbt in 30 seconds

Create a Build Scan® with the quickstart sample project, or follow the steps below with your project. Use of Build Scan® is subject to our Terms of Use. By publishing a Build Scan®, you agree to our Terms of Use.

1. Apply the plugin

Add this code snippet to the project/plugins.sbt file for your project. By adding this code snippet, you agree to our Terms of Use.

addSbtPlugin("com.gradle" % "sbt-gradle-enterprise" % "0.10.1")

2. Apply the configuration

Add this code snippet to the build.sbt file for your project to accept the terms of services.

Global / gradleEnterpriseConfiguration := GradleEnterpriseConfiguration( buildScan = BuildScan( termsOfService = Some(url("https://gradle.com/terms-of-service") -> true) ) )

3. Run your build

sbt package

Learn more

You can even extend each Build Scan with custom data, and more. Learn how via the Develocity sbt plugin User Manual.