gradle
8.3

# include

open fun include(projectPaths: Array<String>)

Adds the given projects to the build. Each path in the supplied list is treated as the path of a project to add to the build. Note that these path are not file paths, but instead specify the location of the new project in the project hierarchy. As such, the supplied paths must use the ':' character as separator (and NOT '/').

The last element of the supplied path is used as the project name. The supplied path is converted to a project directory relative to the root project directory. The project directory can be altered by changing the 'projectDir' property after the project has been included (see setProjectDir)

As an example, the path `a:b` adds a project with path `:a:b`, name `b` and project directory `$rootDir/a/b`. It also adds the a project with path `:a`, name `a` and project directory `$rootDir/a`, if it does not exist already.

Some common examples of using the project path are:

      // include two projects, 'foo' and 'foo:bar'
      // directories are inferred by replacing ':' with '/'
      include 'foo:bar'

      // include one project whose project dir does not match the logical project path
      include 'baz'
      project(':baz').projectDir = file('foo/baz')

      // include many projects whose project dirs do not match the logical project paths
      file('subprojects').eachDir { dir ->
        include dir.name
        project(":${dir.name}").projectDir = dir
      }

Content copied to clipboard

#### Parameters

projectPaths

the projects to add.

abstract fun include(projectPaths: Iterable<String>)

Adds the given projects to the build. Each path in the supplied list is treated as the path of a project to add to the build. Note that these path are not file paths, but instead specify the location of the new project in the project hierarchy. As such, the supplied paths must use the ':' character as separator (and NOT '/').

The last element of the supplied path is used as the project name. The supplied path is converted to a project directory relative to the root project directory. The project directory can be altered by changing the 'projectDir' property after the project has been included (see setProjectDir)

As an example, the path `a:b` adds a project with path `:a:b`, name `b` and project directory `$rootDir/a/b`. It also adds the a project with path `:a`, name `a` and project directory `$rootDir/a`, if it does not exist already.

Some common examples of using the project path are:

      // include two projects, 'foo' and 'foo:bar'
      // directories are inferred by replacing ':' with '/'
      include(['foo:bar'])

      // include one project whose project dir does not match the logical project path
      include(['baz'])
      project(':baz').projectDir = file('foo/baz')

      // include many projects whose project dirs do not match the logical project paths
      file('subprojects').eachDir { dir ->
        include([dir.name])
        project(":${dir.name}").projectDir = dir
      }

Content copied to clipboard

#### Parameters

projectPaths

the projects to add.