Gradle Settings Script and Settings Instance: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
=External=
=DEPLETE TO=
 
{{Internal|Gradle Settings|Gradle Settings}}
* https://docs.gradle.org/current/dsl/org.gradle.api.initialization.Settings.html
 
=Internal=
 
* [[Gradle_Concepts#Settings_Script|Gradle Concepts]]


=Overview=
=Overview=
Line 36: Line 31:
* If found, Gradle checks if the current project is part of multi-project hierarchy defined in the found settings.gradle file. If not, the build is executed as a single project build. Otherwise, a multi project build executed.
* If found, Gradle checks if the current project is part of multi-project hierarchy defined in the found settings.gradle file. If not, the build is executed as a single project build. Otherwise, a multi project build executed.


=<span id='ProjectDescriptor'></span>ProjectDescriptor - Access to Projects from Settings=
=rootProject.name=
 
{{External|https://docs.gradle.org/4.7/javadoc/org/gradle/api/initialization/ProjectDescriptor.html}}
 
Project information can be accessed from the settings.gradle file via [https://docs.gradle.org/4.7/javadoc/org/gradle/api/initialization/ProjectDescriptor.html ProjectDescriptor] instances. Project instances [[Gradle_Concepts#Project_Instance_Creation|are not accessible at this stage]]. ProjectDescriptor instances are created when a new project is added to the build from the settings script via <tt>include</tt> or <tt>includeFlat</tt>.
 
The ProjectDescriptor instances can be looked up in settings.gradle as follows:


<syntaxhighlight lang='groovy'>
<syntaxhighlight lang='groovy'>
project(':subproject-A')
rootProject.name = 'some-name'
</syntaxhighlight>
<syntaxhighlight lang='groovy'>
findProject(':subproject-A')
</syntaxhighlight>
</syntaxhighlight>


The methods take a path as arguments and return the corresponding ProjectDescriptor instance. The ProjectDescriptor instance can be use to access and mutate state of the corresponding project.
More details:
 
=rootProject.name=


{{Internal|Gradle_Project_Properties#rootProject|rootProject}}
{{Internal|Gradle_Project_Coordinates,_State_and_Configured_Properties#rootProject|rootProject}}

Latest revision as of 21:39, 11 October 2020

DEPLETE TO

Gradle Settings

Overview

The settings.gradle file describes the build's project hierarchy. In the simplest case, there is no settings.gradle, and the build consists in just a single project, the root project. In more complex cases, various sub-project hierarchies can be specified. The file can also be used to add libraries to the build script classpath. The configuration file is executed during the initialization phase and updates the state of the delegate Settings instance. For single-project builds, this file is optional. However, it is required for multi-project builds: the root project of the multi-project build must declare this file.

Project Hierarchy

TODO: next time I am here, describe differences between 'include' and 'includeFlat'.

The sub-projects of a multi-project build are declared in the settings.gradle file of the root project with the Settings include(...) or includeFlat(...) methods: 

include 'subproject1', 'subproject2:child1'

The include(...) method specifies a multi-project build hierarchical layout. It takes hierarchical project paths as arguments. 

includeFlat 'subproject1', 'subproject2'

The includeFlat(...) method specifies a multi-project build flat layout. It expects a flat sibling structure.

Resolution

  • Look at a directory called "master" on the same nesting level as the current directory.
  • If not found, search parent directories.
  • If not found, the build executes as a single project build.
  • If found, Gradle checks if the current project is part of multi-project hierarchy defined in the found settings.gradle file. If not, the build is executed as a single project build. Otherwise, a multi project build executed.

rootProject.name

rootProject.name = 'some-name'

More details:

rootProject
Retrieved from "https://kb.novaordis.com/index.php?title=Gradle_Settings_Script_and_Settings_Instance&oldid=71372"