Skip to content

Subprojects Gradle config should accept typed project references instead of strings #1113

@zach-klippenstein

Description

@zach-klippenstein

The Dokka Gradle plugin supports aggregating output from multiple sub projects into a single generated site/artifact by specifying the sub projects to include via the subProjects property. However, this property takes a collection of raw strings. It is not obvious what the format should be for these: fully-qualified project paths? Just the leaf project name? The answer is documented in the README, but if you do the wrong thing, the Dokka task will just fail silently (since it doesn't fail if you specify non-existent projects).

I propose this configuration should accept Gradle project objects instead. This is more self-documenting, and stronger typed, so Gradle will actually fail with a more helpful error message if you do the wrong thing.

Metadata

Metadata

Assignees

Labels

enhancementAn issue for a feature or an overall improvementrunner: Gradle pluginAn issue/PR related to Dokka's Gradle plugin

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions