docs.gradle.org Open in urlscan Pro
2606:4700::6811:2e36  Public Scan

Submitted URL: http://docs.gradle.org/
Effective URL: https://docs.gradle.org/current/userguide/userguide.html
Submission: On March 24 via manual from CA — Scanned from CA

Form analysis 0 forms found in the DOM

Text Content

Gradle
User Manual
 * 8.0.2 Open Community Menu
   7.3
   6.9.1
   5.6.4
   4.10.3
   All versions

 * Community
   Community Home
   Community Forums
   Community Plugins
 * Training
 * News
   Newsletter
   Blog
   Twitter
 * Enterprise
 * github


INTRODUCTION

 * What is Gradle?
 * Gradle Enterprise


WHAT IS NEW?

 * Release Notes
 * Upgrading Gradle
   * version 7.X to 8.0
   * version 6.X to 7.0
   * version 5.X to 6.0
   * version 4.X to 5.0
   * Gradle's Feature Lifecycle
 * Compatibility Notes


QUICK START

 * Getting Started
 * Installing Gradle
 * Samples
 * Migrating to Gradle
   * from Maven
   * from Ant
 * Gradle DSLs and API
   * Javadoc
   * Groovy DSL Primer
   * Groovy DSL Reference
   * Kotlin DSL Primer
   * Kotlin DSL API
   * Groovy to Kotlin DSL Migration
 * Troubleshooting Builds


RUNNING GRADLE BUILDS

 * Command-Line Interface
 * The Gradle Wrapper
 * Customizing Execution
   * Configure the Build Environment
   * Gradle Daemon
   * File System Watching
   * Initialization Scripts
 * Executing Multi-Project Builds


AUTHORING GRADLE BUILDS

 * Learning the Basics
   * Understanding the Build Lifecycle
   * Gradle-managed Directories
   * Writing Build Scripts
   * Learning More About Build Scripts
   * Using Gradle Plugins
   * Working with Files
   * Working with Logging
   * Avoiding Traps
 * Structuring Individual Builds
   * Creating a Basic Multi-Project Build
   * Declaring Dependencies between Subprojects
   * Sharing Build Logic between Subprojects
   * Fine Tuning the Project Layout
   * Understanding Configuration and Execution
 * Structuring Software Products
   * Structuring Large Projects
   * Tweaking Project Structure
   * Composing Builds
 * Authoring Sustainable Builds
   * Organizing Build Logic
   * Following Best Practices
 * Developing Gradle Tasks
   * Authoring Tasks
   * Incremental build
   * Writing Gradle Task Types
   * Configuring Tasks Lazily
   * Avoiding Unnecessary Task Configuration
   * Developing Parallel Tasks
 * Developing Gradle Plugins
   * Starting Plugin Development
   * Designing Plugins
   * Implementing Plugins
   * Testing Plugins
   * Publishing Plugins
 * Other Developing Gradle Topics
   * Writing Custom Gradle Types and Service Injection
   * Shared Build Services
   * Testing a Build with TestKit
   * Using Ant from Gradle


AUTHORING JVM BUILDS

 * Building Java & JVM projects
 * Testing Java & JVM projects
 * Java Toolchains
   * Toolchains for JVM projects
   * Toolchain Resolver Plugins
 * Managing Dependencies
 * JVM Plugins
   * Java Library Plugin
   * Java Application Plugin
   * Java Platform Plugin
   * Groovy Plugin
   * Scala Plugin


WORKING WITH DEPENDENCIES

 * Terminology
 * Learning the Basics
   * What is Dependency Management?
   * Declaring Repositories
   * Declaring Dependencies
   * Understanding Library and Application Differences
   * Viewing and Debugging Dependencies
   * Understanding Resolution
   * Verifying dependencies
 * Declaring Versions
   * Declaring Versions and Ranges
   * Declaring Rich Versions
   * Handling Changing Versions
   * Locking Versions
 * Controlling Transitives
   * Upgrading Versions
   * Downgrading and Excluding
   * Sharing Versions
   * Aligning Dependencies
   * Handling Mutually Exclusive Dependencies
   * Fixing Metadata
   * Customizing Resolution
   * Preventing accidental upgrades
 * Producing and Consuming Variants of Libraries
   * Declaring Capabilities of a Library
   * Modeling Feature Variants and Optional Dependencies
   * Understanding Variant Selection
   * Declaring Variant Attributes
   * Sharing Outputs of Projects
   * Transforming Artifacts
 * Publishing Libraries
   * Setting up Publishing
   * Understanding Gradle Module Metadata
   * Signing Artifacts
   * Customizing Publishing
   * Maven Publish Plugin
   * Ivy Publish Plugin


OPTIMIZING BUILD TIMES

 * Improving Performance of Gradle Builds
 * Using the Build Cache
   * Enabling and Configuring
   * Why use the Build Cache?
   * Understanding the Impact
   * Learning Basic Concepts
   * Caching Java Project
   * Caching Android Project
   * Debugging Caching Issues
   * Troubleshooting
 * Using the Configuration Cache
 * Inspecting Gradle Builds


AUTHORING C++/SWIFT BUILDS

 * Building C++ projects
 * Testing C++ projects
 * Building Swift projects
 * Testing Swift projects


GRADLE ON CI

 * Jenkins
 * TeamCity
 * GitHub Actions
 * Travis CI


REFERENCE

 * Core Plugins
 * Gradle & Third-party Tools
 * User Manual PDF


GRADLE USER MANUAL

version 8.0.2
Contents
 * New projects with Gradle
 * Using existing Gradle builds
 * Getting help
 * Licenses

Want to learn the tips and tricks top engineering teams use to keep builds fast
and performant? Register here for our Build Cache Training.

Gradle is an open-source build automation tool focused on flexibility and
performance. Gradle build scripts are written using a Groovy or Kotlin DSL. Read
about Gradle features to learn what is possible with Gradle.

 * Highly customizable — Gradle is modeled in a way that is customizable and
   extensible in the most fundamental ways.

 * Fast — Gradle completes tasks quickly by reusing outputs from previous
   executions, processing only inputs that changed, and executing tasks in
   parallel.

 * Powerful — Gradle is the official build tool for Android, and comes with
   support for many popular languages and technologies.




NEW PROJECTS WITH GRADLE

Getting started with Gradle is easy! First, follow our guide to download and
install Gradle, then check out our samples to create your first build.

If you’re currently using Maven, see a visual Gradle vs Maven comparison and
follow the guide for migrating from Maven to Gradle.


USING EXISTING GRADLE BUILDS

Gradle supports many major IDEs, including Android Studio, Eclipse, IntelliJ
IDEA, Visual Studio 2019, and XCode. You can also invoke Gradle via its
command-line interface in your terminal or through your continuous integration
server. Gradle Build Scan™ help you understand build results, improve build
performance, and collaborate to fix problems faster.




GETTING HELP

 * Forum — The fastest way to get help is through the Gradle Forum. Community
   members and core contributors answer your questions.

 * Training — Free, web-based Gradle training from Gradle developers happens
   every month. Head over to the training page to sign up.

 * Enterprise Services — Support and training can be purchased alongside a
   Gradle Enterprise subscription.


LICENSES

Gradle build tool source code is open and licensed under the Apache License 2.0.
Gradle user manual and DSL reference manual are licensed under Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International License.

Docs
 * User Manual
 * DSL Reference
 * Release Notes
 * Javadoc

News
 * Blog
 * Newsletter
 * Twitter
 * Status Page

Products
 * Build Scan™
 * Build Cache
 * Enterprise Docs

Get Help
 * Forums
 * GitHub
 * Training
 * Services

STAY UP-TO-DATE ON NEW FEATURES AND NEWS

By entering your email, you agree to our Terms and Privacy Policy, including
receipt of emails. You can unsubscribe at any time.


© Gradle Inc. 2022 All rights reserved.
gradle
Careers | Privacy | Terms of Service | Contact
This website uses cookies and other technology to provide you a more
personalized experience.Accept