Get started with Build Scan™ for Gradle and Apache Maven™

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 and Maven build tools for free.

Publishing a Build Scan to scans.gradle.com transmits information about your Gradle and Maven 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.

Gradle Enterprise, 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

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.

Gradle 4.3+ Gradle < 4.3

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.

plugins {
    id 'com.gradle.enterprise' 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 Gradle Enterprise 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.

1. Apply the extension

Declare the Gradle Enterprise 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.17.2</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 Gradle Enterprise Maven Extension User Manual.