Gradle Build Language Reference

Configures this project and each of its sub-projects.

Configures the published artifacts for this project.

Configures the build script classpath for this project.

Configures the dependency configurations for this project.

Configures the dependencies for this project.

Configures the repositories for this project.

Configures the source sets of this project.

Configures the sub-projects of this project.

Configures the PublishingExtension added by the publishing plugin.

This interface is the main API you use to interact with Gradle from your build file. From a Project, you have programmatic access to all of Gradle's features.

A Task represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.

Represents an invocation of Gradle.

Declares the configuration required to instantiate and configure the hierarchy of Project instances which are to participate in a build.

A build that is included in the composite.

Provides access to several important locations for a project.

Provides access to important locations for a Gradle build.

This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods. As your compiled script class will implement this interface, you can use the methods and properties declared by this interface directly in your script.

A SourceSet represents a logical group of Java source and resource files. They are covered in more detail in the user manual.

A collection of all output directories (compiled classes, processed resources, etc.) - notice that SourceSetOutput extends FileCollection.

A SourceDirectorySet represents a set of source files composed from a set of source directories, along with associated include and exclude patterns.

A Configuration represents a group of artifacts and their dependencies. Find more information about declaring dependencies to a configuration or about managing configurations in docs for ConfigurationContainer

A Configuration which can be consumed via Publishing and Dependency Management.

A Configuration which performs dependency resolution to build dependency graphs and resolve artifacts.

A Configuration which collects dependencies, dependency constraints, and exclude rules.

Defines the strategies around dependency resolution. For example, forcing certain dependency versions, substitutions, conflict resolutions or snapshot timeouts.

A builder to construct a query that can resolve selected software artifacts of the specified components.

Represents a tuple of the component selector of a module and a candidate version to be evaluated in a component selection rule.

Represents a container for component selection rules. Rules can be applied as part of the resolutionStrategy of a configuration and individual components can be explicitly accepted or rejected by rule. Components that are neither accepted or rejected will be subject to the default version matching strategies.

A DependencyCollector is used as part of a dependencies block in the DSL. A collector implements a single dependency scope and exposes the declared dependencies on DependencyCollector.getDependencies().

Objects that can be extended at runtime with other objects.

Additional, ad-hoc, properties for Gradle domain objects.

The DSL for declaring plugins to use in a script.

A mutable specification of a dependency on a plugin.

Configures how plugins are resolved.

A factory for creating instances of Provider.

Provides access to resource-specific utility methods, for example factory methods that create various resources.

Creates TextResources backed by sources such as strings, files, and archive entries.

Provides access to any input files that need to be processed by an incremental work action.

A distribution allows to bundle an application or a library including dependencies, sources...

The configuration of how to “publish” the different components of a project.

An IvyPublication is the representation/configuration of how Gradle should publish something in Ivy format, to an Ivy repository. You directly add a named Ivy publication the project's publishing.publications container by providing IvyPublication as the type.

An artifact published as part of a IvyPublication.

A Collection of IvyArtifacts to be included in an IvyPublication. Being a DomainObjectSet, an IvyArtifactSet provides convenient methods for querying, filtering, and applying actions to the set of IvyArtifacts.

The descriptor of any Ivy publication.

An author of an Ivy publication.

A license of an Ivy publication.

The description of an Ivy publication.

A MavenPublication is the representation/configuration of how Gradle should publish something in Maven format. You directly add a named Maven publication the project's publishing.publications container by providing MavenPublication as the type.

An artifact published as part of a MavenPublication.

A Collection of MavenArtifacts to be included in a MavenPublication. Being a DomainObjectSet, a MavenArtifactSet provides convenient methods for querying, filtering, and applying actions to the set of MavenArtifacts.

The POM for a Maven publication.

The CI management system of a Maven publication.

A contributor of a Maven publication.

Allows to add contributors of a Maven publication.

A developer of a Maven publication.

Allows to add developers to a Maven publication.

The distribution management configuration of a Maven publication.

The issue management system of a Maven publication.

A license of a Maven publication.

Allows to add licenses to a Maven publication.

A mailing list of a Maven publication.

Allows to add mailing lists to a Maven publication.

The organization of a Maven publication.

The relocation information of a Maven publication that has been moved to a new group and/or artifact ID.

The SCM (source control management) of a Maven publication.

A TaskContainer is responsible for managing a set of Task instances.

A ConfigurationContainer is responsible for declaring and managing configurations. See also Configuration.

A RepositoryHandler manages a set of repositories, allowing repositories to be defined and queried.

A DependencyHandler is used to declare dependencies. Dependencies are grouped into configurations (see Configuration).

Allows the build to provide rules that modify the metadata of depended-on software components. Component metadata rules are applied in the components section of the dependencies block DependencyHandler of a build script. The rules can be defined in two different ways:

This class is for defining artifacts to be published and adding them to configurations. Creating publish artifacts does not mean to create an archive. What is created is a domain object which represents a file to be published and information on how it should be published (e.g. the name).

An artifact repository which supports username/password authentication.

Base interface for credentials used for different authentication purposes. (e.g authenticated RepositoryHandler)

A username/password credentials that can be used to login to password-protected remote repository.

Represents credentials used to authenticate with Amazon Web Services.

Credentials that can be used to login to a protected server, e.g. a remote repository by using HTTP header. The properties used for creating credentials from a property are repoAuthHeaderName and repoAuthHeaderValue, where repo is the identity of the repository.

Container for configuring repository authentication schemes of type Authentication.

Base interface for transport authentication schemes.

Authentication scheme for basic access authentication over HTTP. When using this scheme, credentials are sent preemptively.

Authentication scheme for HTTP header authentication over HTTP.

Authentication scheme for digest access authentication over HTTP.

Configuration for the build cache for an entire Gradle build.

Configuration object for the local directory build cache.

Configuration object for the HTTP build cache. Cache entries are loaded via GET and stored via PUT requests.

Used to configure input normalization. Currently, it is only possible to configure runtime classpath normalization.

Input normalization configuration. Input normalization is used when Gradle tries to determine if two task inputs are different. Gradle normalizes both inputs and the inputs are considered different if and only if the normalizations are different.

Configuration of runtime classpath normalization.

Displays a list of tasks in the project. An instance of this type is used when you execute the tasks task from the command-line.

Displays a list of projects in the build. An instance of this type is used when you execute the projects task from the command-line.

Displays the dependency tree for a project. An instance of this type is used when you execute the dependencies task from the command-line.

Generates a report that attempts to answer questions like:

Displays the properties of a project. An instance of this type is used when you execute the properties task from the command-line.

Displays some details about the software components produced by the project.

Displays dependent components.

Displays some details about the configuration model of the project. An instance of this type is used when you execute the model task from the command-line.

A task which reports the outgoing variants of a project on the command line. This is useful for listing what a project produces in terms of variants and what artifacts are attached to each variant. Variants, in this context, must be understood as "things produced by a project which can safely be consumed by another project".

A task which reports the configurations of a project which can be resolved on the command line. This is useful for determining which attributes are associated with the resolvable configurations being used to resolve a project's dependencies. The output can help predict which variant of each dependency will be resolved.

Generates parsers from Antlr grammars.

Provides information about the build environment for the project that the task is associated with.

Runs Checkstyle against some source files.

Runs CodeNarc against some source files.

Copies files into a destination directory. This task can also rename and filter files as it copies. The task implements CopySpec for specifying what to copy.

Creates start scripts for launching JVM applications.

Deletes files or directories. Example:

Assembles an EAR archive.

Executes a command line process. Example:

Generates an Ivy XML Module Descriptor file.

Generates a Maven module descriptor (POM) file.

Generates build dashboard report.

Executes a Gradle build.

Compiles Groovy source files, and optionally, Java source files.

Generates HTML API documentation for Groovy source, and optionally, Java source.

Generates an HTML dependency report. This report combines the features of the ASCII dependency report and those of the ASCII dependency insight report. For a given project, it generates a tree of the dependencies of every configuration, and each dependency can be clicked to show the insight of this dependency.

Task to generate HTML, Xml and CSV reports of Jacoco coverage data.

Task for verifying code coverage metrics. Fails the task if violations are detected based on specified rules.

Assembles a JAR archive.

Compiles Java source files.

Generates HTML API documentation for Java classes.

Executes a Java application in a child process.

Runs a set of static code analysis rules on Java source code files and generates a report of problems found.

Copies resources from their source to their target directory, potentially processing them. Makes sure no stale resources remain in the target directory.

Publishes an IvyPublication to an IvyArtifactRepository.

Publishes a MavenPublication to a MavenArtifactRepository.

Compiles Scala source files, and optionally, Java source files.

Generates HTML API documentation for Scala source files.

Generates or updates the Gradle Daemon JVM criteria. This controls the version of the JVM required to run the Gradle Daemon.

Generates a Gradle project structure.

A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.

Synchronizes the contents of a destination directory with some source directories and files.

Assembles a TAR archive.

Abstract class for all test tasks.

Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.

Generates an HTML test report from the results of one or more Test tasks.

Assembles a WAR archive.

Generates scripts (for *nix and windows) which allow you to build your project with Gradle, without having to install Gradle.

Writes a Properties in a way that the results can be expected to be reproducible.

Assembles a ZIP archive. The default is to compress the contents of the zip.

This DSL element exists to contain a collection of TestSuites.

Base test suite component. A test suite is a collection of tests.

A test suite is a collection of JVM-based tests.

Base test suite target. A test suite target is a collection of tests that run in a particular context (operating system, Java runtime, etc).

Defines the target environment against which a JvmTestSuite will be run.

Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.

Universal APIs that are available for all dependencies blocks.

Dependency APIs available for dependencies blocks that can build software that relies on Gradle APIs.

Dependency modifier APIs that can find test fixtures in other modules for dependencies blocks.

Dependency modifier APIs that can find platform and enforced platforms in other modules for dependencies blocks.

This DSL element is used to add dependencies to a component, for instance a TestSuite

A HTML Report whose generation can be customized with a XSLT stylesheet.

A report that is a single file.

A directory based report to be created.

A file based report to be created.

An object that provides reporting options.

A container of Report objects, that represent potential reports.

A project extension named "reporting" that provides basic reporting settings and utilities.

A container for the inputs of an aggregated test report.

A container for the inputs of an aggregated JaCoCo code coverage report.

DSL-friendly model of the Eclipse project information. First point of entry for customizing Eclipse project generation.

Enables fine-tuning project details (.project file) of the Eclipse plugin

The build path settings for the generated Eclipse project. Used by the GenerateEclipseClasspath task to generate an Eclipse .classpath file.

Enables fine-tuning jdt details of the Eclipse plugin

Enables fine-tuning wtp/wst details of the Eclipse plugin

Enables fine-tuning wtp component details of the Eclipse plugin

Enables fine-tuning wtp facet details of the Eclipse plugin

DSL-friendly model of the IDEA project information. First point of entry when it comes to customizing the IDEA generation.

Enables fine-tuning project details (*.ipr file) of the IDEA plugin.

Enables fine-tuning module details (*.iml file) of the IDEA plugin.

Enables fine-tuning workspace details (*.iws file) of the IDEA plugin.

Models the generation/parsing/merging capabilities. Adds XML-related hooks.

Models the generation/parsing/merging capabilities.

Generates an Eclipse .project file. If you want to fine tune the eclipse configuration

Generates an Eclipse .classpath file. If you want to fine tune the eclipse configuration

Generates the Eclipse JDT configuration file. If you want to fine tune the eclipse configuration

Generates the org.eclipse.wst.common.component settings file for Eclipse WTP. If you want to fine tune the eclipse configuration

Generates the org.eclipse.wst.common.project.facet.core settings file for Eclipse WTP. If you want to fine tune the eclipse configuration

Generates an IDEA module file. If you want to fine tune the idea configuration

Generates an IDEA project file for root project *only*. If you want to fine tune the idea configuration

Generates an IDEA workspace file *only* for root project. There's little you can configure about workspace generation at the moment.

Task for generating a Xcode scheme file (e.g. Foo.xcodeproj/xcshareddata/xcschemes/Foo.xcscheme). An Xcode scheme defines a collection of targets to build, a configuration to use when building, and a collection of tests to execute.

Task for generating a Xcode workspace settings file (e.g. Foo.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings).

Task for generating a Xcode project file (e.g. Foo.xcodeproj/project.pbxproj). A project contains all the elements used to build your products and maintains the relationships between those elements. It contains one or more targets, which specify how to build products. A project defines default build settings for all the targets in the project (each target can also specify its own build settings, which override the project build settings).

Task for generating a Xcode workspace file (e.g. Foo.xcworkspace/contents.xcworkspacedata). A workspace can contain any number of Xcode projects.

Task for generating a Visual Studio solution file (e.g. foo.sln).

Task for generating a Visual Studio project file (e.g. foo.vcxproj).

Task for generating a Visual Studio filters file (e.g. foo.vcxproj.filters).

Interface for artifact transform actions.

The outputs of the artifact transform.

Base configuration for artifact transform registrations.

The GNU GCC tool chain.

The Clang tool chain.

The Visual C++ tool chain.

The Swift Compiler tool chain.

A library component that is not built by gradle.

A shared library that exists at a known location on the filesystem.

A static library that exists at a known location on the filesystem.

Definition of a software component that is to be built by Gradle to run a on JVM platform.

Definition of a native executable component that is to be built by Gradle.

Definition of a native library component that is to be built by Gradle.

A component representing a suite of tests that will be executed together.

Test suite of CUnit tests.

Test suite of Google Test tests.

Represents a binary artifact that is the result of building a native component.

An binary built by Gradle for a native application.

Represents a binary artifact that is the result of building a native library component.

A shared library binary built by Gradle for a native library.

A static library binary built by Gradle for a native library.

An executable which runs a suite of tests.

An executable which run a CUnit test suite.

An executable which run a Google Test test suite.

A target platform for building native binaries. Each target platform is given a name, and may optionally be given a specific Architecture and/or OperatingSystem to target.

Specifies a build-type for a native binary. Common build types are 'debug' and 'release', but others may be defined.

Defines a custom variant that differentiate a NativeBinary.

A set of assembly language sources.

A set of C source files.

A set of C++ source files.

A set of Objective-C source files.

A set of Objective-C++ source files.

A set of Windows Resource definition files.

A visual studio project, created from one or more native binaries.

A visual studio solution, representing one or more native binaries in a build.

An executable native component that is built by Gradle.

A library component that is built by a gradle project.

Represents a particular binary artifact.

A binary artifact for a NativeExecutable, targeted at a particular platform with specific configuration.

A NativeLibrary that has been compiled and linked as a shared library.

A NativeLibrary that has been compiled and archived into a static library.

Configuration for a C++ application, defining the source files that make up the application plus other settings.

Configuration for a C++ library, defining the source files and header directories that make up the library plus other settings.

A C++ test suite.

Configuration for a Swift application, defining the source files that make up the application plus other settings.

Configuration for a Swift library, defining the source files that make up the library plus other settings.

A XCTest suite, implemented in Swift.

Compiles C++ source files into object files.

Compiles Swift source files into object files.

Links a binary executable from object files and libraries.

Links a binary shared library from object files and imported libraries.

Assembles a static library from object files.

Links a binary bundle from object files and imported libraries.

Installs an executable with it's dependent libraries so it can be easily executed.

Creates a XCTest bundle with a run script so it can be easily executed.

Runs a compiled and installed test executable.

Executes XCTest tests. Test are always run in a single execution.

Compiles C source files into object files.

Translates Assembly language source files into object files.

Compiles Objective-C source files into object files.

Compiles Objective-C++ source files into object files.

Compiles Windows Resource scripts into .res files.