Gradle Project

External

• Project API: org.gradle.api.Project
• Project DSL: https://docs.gradle.org/current/dsl/org.gradle.api.Project.html

Internal

• Gradle Concepts
• build.gradle
• Gradle Logging

Overview

A Gradle project typically represents a software component to be built by executing a set of tasks in sequence. A project has a direct class representation in the Gradle domain model: org.gradle.api.Project. The Project instance is exposed for query and modification via the build.gradle file. Each project has its own build.gradle file.

The project instance is available to the build.gradle script via the project variable, which corresponds to the Project.getProject() accessor. The project instance is not available in settings.gradle, only the root project descriptor via rootProject variable, which corresponds to Settings.getRootProject(). You are not required to use the project variable when accessing properties and methods of the project from build.gradle, it is assumed you mean the Project instance.

Project API and build.gradle DSL

The build script classpath for the project can be configured with Project.buildscript(Closure) which corresponds to the "buildscript" DSL element:

buildscript {
  // configuration closure
}

See:

Build Script Classpath

Plugins for the build can be declare with PluginAware.apply(...), which corresponds to the "apply" DSL element:

apply plugin:|from: '...'

See:

Using a Plugin

The project's coordinates and other state properties are available through a series of DSL variables: name, group, version, description, path, etc. Some of the coordinates, such as "group" and "version" can be also set in build.gradle with a variable assignment, while others, such as "name" cannot be changed.

group = "io.playground"
version = "0.1.0"
description = "Example project"
logger.info "Project coordinates: ${group} ${name} ${version} ${description} ${path}"

See:

Gradle Project Coordinates and State Properties

The project logger is also accessible in build.gradle. See:

Gradle Logging

Dependencies and configurations can be managed with the "dependencies" and "configurations" DSL elements:

dependencies {
  // configuration closure
}
configurations {
  // configuration closure
}

See:

Gradle Dependencies and Dependency Configurations

The DSL exposes project-level methods for file resolution:

File f = file('./some/path/inside/project')

See:

Gradle File Resolution

The project allows declaring new tasks in build.gradle and also defining completely new tasks in-line. See:

Gradle Tasks

build.gradle Example

build.gradle Example

Prject Coordinates and State Properties

Gradle Project Coordinates, State and Configured Properties

Project Name

Gradle Project Coordinates, State and Configured Properties | Project Name

Build Directory

Gradle Project Coordinates, State and Configured Properties | Build Directory

Multi-Project Builds

Multi-Project Builds

Project Structure

A project contains:

Task Container

A task container, available via the Project.getTasks() method call. The task container manages the project's tasks. Also see: https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskContainer.html

TO DEPLETE

Gradle Project and Build Script