-
Notifications
You must be signed in to change notification settings - Fork 455
Open
Labels
enhancementAn issue for a feature or an overall improvementAn issue for a feature or an overall improvementtech-debtA technical issue that is not observable by the users, but improves maintainers quality of lifeA technical issue that is not observable by the users, but improves maintainers quality of life
Description
Tech debt
The Maven artifacts that are currently published by Dokka are somewhat inconsistent:
- There's no distinction between a simple Dokka plugin (
mathjax-plugin
), a Dokka runner (dokka-maven-plugin
) and an output format (gfm-plugin
), although all of them are plugins in their own right. - Some artifact names are prefixed with
dokka-
(likedokka-core
anddokka-base
), others are not. dokka-test-api
is in reality test API fordokka-core
, which isn't obvious.- It's unclear whether
dokka-base
needs special treatment, since it's just a Dokka plugin (should it bebase-plugin
instead?) - Artifact names like
plugin-jekyll-template-processing
are not user friendly, although they are expected to be used in non-Gradle runners for generating multimodule documentation. Should they even be published as a separate artifact? (can probably be bundled with the main format plugin, and enabled conditionally ifall-modules-page
plugin is on classpath)
These inconsistencies and the lack of an easy to follow logic in naming leads to problems with perception, and makes it difficult to use Gradle's composite builds (they require the name of the project to be the same as the artifact name).
Proposed solution
The artifact names should be revisited:
- Think of and agree on consistent artifact naming guidelines for Dokka.
- Rename the published artifacts.
- Configure relocation for the renamed artifacts.
This issue came into existence after it started getting in the way of #3174. Temporary workarounds have been put in place until this issue is resolved.
aSemy
Metadata
Metadata
Assignees
Labels
enhancementAn issue for a feature or an overall improvementAn issue for a feature or an overall improvementtech-debtA technical issue that is not observable by the users, but improves maintainers quality of lifeA technical issue that is not observable by the users, but improves maintainers quality of life