CINXE.COM
Run a free Build Scan® for Gradle, Apache Maven, and sbt builds | Gradle
<!DOCTYPE html> <html lang="en-US"> <head> <title> Run a free Build Scan® for Gradle, Apache Maven, and sbt builds | Gradle </title> <!-- Primary Meta Tags --> <meta name="title" content="Run a free Build Scan® for Gradle, Apache Maven, and sbt builds | Gradle" /> <meta name="description" content="Get detailed analytic information about your build so you can quickly fix problems and debug performance issues." /> <!-- Open Graph / Facebook --> <meta property="og:type" content="website" /> <meta property="og:url" content="https://scans.gradle.com/" /> <meta property="og:title" content="Run a free Build Scan® for Gradle, Apache Maven, and sbt builds | Gradle" /> <meta property="og:description" content="Get detailed analytic information about your build so you can quickly fix problems and debug performance issues." /> <meta property="og:image" content="https://gradle.com/assets/images/opengraph/scans-gradle/meta-image.png" /> <!-- Twitter --> <meta property="twitter:url" content="https://scans.gradle.com/" /> <meta property="twitter:title" content="Run a free Build Scan® for Gradle, Apache Maven, and sbt builds | Gradle" /> <meta property="twitter:description" content="Get detailed analytic information about your build so you can quickly fix problems and debug performance issues." /> <meta property="twitter:image" content="https://gradle.com/assets/images/opengraph/scans-gradle/meta-image.png" /> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css"> <link rel="stylesheet" href="/scans-site-assets/css/styles.css"> <link rel="manifest" href="https://assets.gradle.com/icon/gradle-enterprise/site.webmanifest"> <link rel="icon" href="https://assets.gradle.com/icon/gradle-enterprise/favicon.ico"> <link rel="icon" type="image/png" sizes="32x32" href="https://assets.gradle.com/icon/gradle-enterprise/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="https://assets.gradle.com/icon/gradle-enterprise/favicon-16x16.png"> <link rel="apple-touch-icon" sizes="180x180" href="https://assets.gradle.com/icon/gradle-enterprise/apple-touch-icon.png"> <meta name="theme-color" content="#02303A"> <script src="https://fast.wistia.com/assets/external/E-v1.js" async> </script><!-- Google Tag Manager --> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-WRTQKGT');</script> <!-- End Google Tag Manager --> </head> <body class="get-started"><!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WRTQKGT" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) --> <header class="primary-header"> <nav class="primary-header__navigation"> <div class="primary-header__navigation-header"> <a class="logo" href="https://gradle.com"> <img alt="Develocity Logo" src="/scans-site-assets/img/develocity.svg" style="height: 26px;"> </a> <button type="button" class="primary-header__navigation-button hamburger"> <span class="hamburger__bar"></span> <span class="hamburger__bar"></span> <span class="hamburger__bar"></span> </button> </div> </nav> </header> <main> <div class="layout layout--narrow" style="padding-bottom: 50px"> <h1>Get started with Build Scan® for Gradle, Apache Maven™, and sbt</h1> <section> <p> A <a href="https://gradle.com/help/build-scans">Build Scan®</a> 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 <strong>Gradle</strong>, <strong>Maven</strong> and <strong>sbt</strong> build tools for free. </p> <p> Publishing a Build Scan to scans.gradle.com transmits information about your <a href="https://gradle.com/help/gradle-plugin-captured-information">Gradle</a>, <a href="https://gradle.com/help/maven-extension-captured-information">Maven</a> and <a href="https://gradle.com/help/sbt-plugin-captured-information">sbt</a> 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. </p> <p> 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. </p> <p> <a href="https://gradle.com/">Develocity</a>, our on-premises software, provides a version of the Build Scan service with additional features. </p> <div class="badges"> <div class="badge badge--gradle" onclick="selectGradle()"> <img class="badge__logo" width="50" height="50" src="scans-site-assets/img/gradle.svg"/> <div class="badge__label badge__label--long">Build Scan® for Gradle</div> <div class="badge__label badge__label--short">Gradle</div> </div> <div class="badge badge--maven" onclick="selectMaven()"> <img class="badge__logo" width="50" height="50" src="scans-site-assets/img/maven.svg"/> <div class="badge__label badge__label--long">Build Scan® for Maven</div> <div class="badge__label badge__label--short">Maven</div> </div> <div class="badge badge--sbt" onclick="selectSbt()"> <img class="badge__logo" width="50" height="50" padding-right="10px" src="scans-site-assets/img/sbt.svg"/> <div class="badge__label badge__label--long">Build Scan® for sbt</div> <div class="badge__label badge__label--short">sbt</div> </div> </div> <script src="https://fast.wistia.com/embed/medias/2w8t4w7d2q.jsonp" async></script> <div class="video video--gradle wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"> <div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"> <div class="wistia_embed wistia_async_2w8t4w7d2q videoFoam=true" style="height:100%;position:relative;width:100%"> <div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"> <img src="https://fast.wistia.com/embed/medias/2w8t4w7d2q/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" onload="this.parentNode.style.opacity=1;"/></div> </div> </div> </div> <script src="https://fast.wistia.com/embed/medias/o9i806vtft.jsonp" async></script> <div class="video video--maven wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"> <div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"> <div class="wistia_embed wistia_async_o9i806vtft videoFoam=true" style="height:100%;position:relative;width:100%"> <div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"> <img src="https://fast.wistia.com/embed/medias/o9i806vtft/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" onload="this.parentNode.style.opacity=1;"/></div> </div> </div> </div> <div class="video-placeholder video--sbt"> <img src="scans-site-assets/jpg/sbt-video-placeholder.jpg" alt=""/> </div> </section> </div> <section class="section--light-gray"> <div class="layout layout--narrow" style="padding-top: 50px; padding-bottom: 50px"> <div class="example example--gradle"> <h1>Create a Build Scan® for Gradle in 30 seconds</h1> <p> Create a Build Scan® with the <a href="https://github.com/gradle/gradle-build-scan-quickstart">quickstart sample project</a>, or follow the steps below with your project. Use of Build Scan® is subject to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. By publishing a Build Scan®, you agree to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. </p> <div class="tab"> <div class="tab_toggles"> <a class="tablinks gradle button button--blue button--toggle" onclick="openTab(event, 'gradle', 'Gradle4.3+')">Gradle 4.3+</a> <a class="tablinks gradle button button--transparent-white button--toggle" onclick="openTab(event, 'gradle', 'Gradle4.3-')">Gradle < 4.3</a> </div> </div> <div id="Gradle4.3+" class="tabcontent gradle active"> <p>Run your build with the <code>--scan</code> option.</p> <div class="block-snippet"> <code>gradle build --scan</code> </div> </div> <div id="Gradle4.3-" class="tabcontent gradle"> <h3>1. Apply the plugin</h3> <p> Add this code snippet to the top of the build.gradle file of the root project, below any <code>buildscript { … }</code> sections if present. By adding this code snippet, you agree to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. <div class="block-snippet-wrapper"> <button type="button" class="copy-snippet-btn js-copy-snippet" aria-label="Copy" data-original-title="" title=""> </button> <div class="block-snippet"> <code>plugins { id 'com.gradle.build-scan' version '1.16' } buildScan { licenseAgreementUrl = 'https://gradle.com/help/legal-terms-of-use' licenseAgree = 'yes' }</code> </div> </div> <h3>2. Run your build</h3> <p>Run your build with the <code>--scan</code> option.</p> <div class="block-snippet"> <code>gradle build --scan</code> </div> </div> <h2>Learn more</h2> <p> 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 <a href="https://gradle.com/help/gradle-plugin">Develocity Gradle Plugin User Manual</a>. </p> </div> <div class="example example--maven"> <h1>Create a Build Scan® for Apache Maven™ in 30 seconds</h1> <p> Create a Build Scan® with the <a href="https://github.com/gradle/maven-build-scan-quickstart">quickstart sample project</a>, or follow the steps below with your project. Use of Build Scan® is subject to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. By publishing a Build Scan®, you agree to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. </p> <div class="maven-tabcontent"> <div class="tab"> <div class="tab_toggles"> <a class="tablinks maven button button--blue button--toggle" onclick="openTab(event, 'maven', 'MavenAuto')">Automated Setup</a> <a class="tablinks maven button button--transparent-white button--toggle" onclick="openTab(event, 'maven', 'MavenManual')">Manual Setup</a> </div> </div> <div id="MavenAuto" class="tabcontent maven active"> <h3>1. Apply the extension</h3> <p> Execute the <code>init</code> goal to quickly set up the Develocity Maven extension on a Maven project. This requires the Develocity Maven extension version <code>1.19+</code>. </p> <div class="block-snippet-wrapper"> <button type="button" class="copy-snippet-btn js-copy-snippet" aria-label="Copy" data-original-title="" title=""> </button> <div class="block-snippet"> <code>mvn com.gradle:develocity-maven-extension:1.22.2:init</code> </div> </div> <h3>2. Run your build</h3> <div class="block-snippet"> <code>mvn install</code> </div> </div> <div id="MavenManual" class="tabcontent maven"> <h3>1. Apply the extension</h3> <p> Declare the Develocity Maven extension in the <code>.mvn/extensions.xml</code> file in your root project. </p> <div class="block-snippet-wrapper"> <a href="scans-site-assets/snippets/extensions.xml" download="extensions.xml"> <button type="button" class="download-snippet-btn" aria-label="Download" data-original-title="" title=""> </button> </a> <button type="button" class="copy-snippet-btn js-copy-snippet" aria-label="Copy" data-original-title="" title=""> </button> <div class="block-snippet"> <code><extensions> <extension> <groupId>com.gradle</groupId> <artifactId>develocity-maven-extension</artifactId> <version>1.22.2</version> </extension> </extensions></code> </div> </div> <h3>2. Run your build</h3> <div class="block-snippet"> <code>mvn install</code> </div> </div> </div> <h2>Learn more</h2> <p> You can even extend each Build Scan with custom data, and more. Learn how via the <a href="https://gradle.com/help/maven-extension">Develocity Maven Extension User Manual</a>. </p> </div> <div class="example example--sbt"> <h1>Create a Build Scan® for sbt in 30 seconds</h1> <p> Create a Build Scan® with the <a href="https://github.com/gradle/sbt-build-scan-quickstart">quickstart sample project</a>, or follow the steps below with your project. Use of Build Scan® is subject to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. By publishing a Build Scan®, you agree to our <a href="https://gradle.com/help/legal-terms-of-use">Terms of Use</a>. </p> <div class="sbt-tabcontent"> <h3>1. Apply the plugin</h3> <p> Add this code snippet to the <code>project/plugins.sbt</code> file for your project. </p> <div class="block-snippet-wrapper"> <button type="button" class="copy-snippet-btn js-copy-snippet" aria-label="Copy" data-original-title="" title=""> </button> <div class="block-snippet"> <code>addSbtPlugin("com.gradle" % "sbt-develocity" % "1.1.2")</code> </div> </div> <h3>2. Run your build</h3> <div class="block-snippet"> <code>sbt package</code> </div> </div> <h2>Learn more</h2> <p> You can even extend each Build Scan with custom data, and more. Learn how via the <a href="https://gradle.com/help/sbt-plugin">Develocity sbt plugin User Manual</a>. </p> </div> </div> </section> </main> <footer class="primary-footer"> <div class="primary-footer__contents"> <div class="primary-footer__copy">© Gradle Inc. <script type="text/javascript">window.document.write('' + new Date().getFullYear());</script> </div> <div class="primary-footer__logo"><a href="https://gradle.com"><img alt="" src="/scans-site-assets/img/footer-logo.svg"></a></div> <div class="primary-footer__links"> <a href="https://gradle.com/help/legal-privacy">Privacy Policy</a> | <a href="https://gradle.com/help/legal-terms-of-use">Terms</a> | <a href="https://status.gradle.com">Status</a> </div> </div> </footer> <script src="/scans-site-assets/js/primary-header.js"></script> <script src="/scans-site-assets/js/jquery/jquery-3.6.0.min.js"></script> <script src="/scans-site-assets/js/bootstrap.min.js"></script> <script src="/scans-site-assets/js/clipboard.min.js"></script> <script src="/scans-site-assets/js/hoverIntent.min.js"></script> <script src="/scans-site-assets/js/custom.js"></script> </body> </html>