Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisit published Maven artifact names (artifactId) #3245

Open
IgnatBeresnev opened this issue Oct 23, 2023 · 0 comments
Open

Revisit published Maven artifact names (artifactId) #3245

IgnatBeresnev opened this issue Oct 23, 2023 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life

Comments

@IgnatBeresnev
Copy link
Member

Tech debt

The Maven artifacts that are currently published by Dokka are somewhat inconsistent:

  1. 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.
  2. Some artifact names are prefixed with dokka- (like dokka-core and dokka-base), others are not.
  3. dokka-test-api is in reality test API for dokka-core, which isn't obvious.
  4. It's unclear whether dokka-base needs special treatment, since it's just a Dokka plugin (should it be base-plugin instead?)
  5. 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 if all-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:

  1. Think of and agree on consistent artifact naming guidelines for Dokka.
  2. Rename the published artifacts.
  3. 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.

@IgnatBeresnev IgnatBeresnev added enhancement An issue for a feature or an overall improvement tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life labels Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life
Projects
None yet
Development

No branches or pull requests

1 participant