Gradle Concepts
External
- API reference https://docs.gradle.org/current/javadoc/index.html
- DSL reference https://docs.gradle.org/current/dsl/
Internal
Overview
Gradle is a general-purpose build tool. It is primarily used to build Java and Groovy, but it can build other languages as well. The goal of a Gradle execution, also known as a Gradle build, is to execute a set of tasks, in sequence. Each build runs according to a well defined build lifecycle, during which Gradle instantiates a complex domain model of the project in memory: a Gradle instance, a Settings instance and the project itself.
Build Lifecycle
A build is a Gradle execution. Each build starts with instantiation of a Settings and Gradle instance, then of at least one project, which in turn contains tasks, and it can be configured and controlled with properties. Depending on the specific of the build, other Gradle core types are instantiated as well. The lifecycle of a Gradle build consists in an initialization, configuration and an execution phase. Code can be written to react to a build's lifecycle events.
Initialization Phase
The build starts with the initialization phase, when Gradle creates a Settings instance, then executes the settings script, which updates the state of its Settings delegate. In this phase, Gradle determines which projects are going to take part in the build and creates a project representation for each of the projects, essentially defining the build's project hierarchy. The sub-projects are declared using the "include" or "includeFlat" Settings methods in settings.gradle.
The corresponding Project instances are created and arranged in the corresponding project hierarchy. Note that at the initialization phase, Project instances are not accessible from the settings script. Project data can be accessed via a ProjectDescriptor interface instead.
In case of a simple project, Gradle creates the Project instance. For a multi-project build, and depending on which project is executed, Gradle figures out which of the project dependencies need to participate in the build. Extra properties for Gradle and Settings object instances can be declared at this phase. None of the build scripts is executed in this phase.
Configuration phase. The code declared in build.gradle is executed in order. Tasks are instantiated and configured, by executing their configuration closures. Any configuration code is executed with every build of the project. Gradle constructs a task DAG. The incremental build features determines if any of the tasks in the model are required to run.
Execution phase. Task actions are executed in the correct order, as determined by their dependencies. Task considered up-to-date are skipped.
Convention over Configuration
Subjects
- Project, Dependencies and Configurations, Multi-Project Builds, Reacting to Build Lifecycle Events
- Task, Extending Gradle with a Custom Enhanced Task
- Gradle Runtime and Project Configuration
- Gradle Instance, Settings Instance
- Logging
- Plugins
- Extending Gradle
- Gradle File Resolution