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

build: Enable the new Dokka Gradle plugin #2341

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

joc-a
Copy link
Collaborator

@joc-a joc-a commented Dec 19, 2024

Description

  • Why: This removes the warning that Dokka Gradle plugin V1 is deprecated.
  • How: By following the guide here.

Type of Change

Please mark the relevant options with an "X":

  • Bug fix
  • New feature
  • Documentation update
  • Other - Build

Updates/remove existing public API methods:

  • Is breaking change

Affected databases:

  • MariaDB
  • Mysql5
  • Mysql8
  • Oracle
  • Postgres
  • SqlServer
  • H2
  • SQLite

Checklist

  • Unit tests are in place
  • The build is green (including the Detekt check)
  • All public methods affected by my PR has up to date API docs
  • Documentation for my change is up to date

Related Issues

@joc-a joc-a marked this pull request as ready for review December 19, 2024 00:43
@joc-a joc-a requested a review from bog-walk December 19, 2024 00:43
Copy link
Member

@bog-walk bog-walk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some additional steps probably need to be taken:

  1. Task dokkaHtmlMultiModule no longer exists in V2, so the github task for building api docs in docs-workflow.yml most likely needs to be changed as shown here.
  2. Current set-up isn't showing warnings, but the guide does suggest switching to dokka { } DSL (see 'Output Directory' point in this section)
  3. I'm not sure about this, but maybe changes suggested here need to also be made given that this is a multi-module project?

This migrates to Dokka Gradle plugin v2 and removes the warning that Dokka Gradle plugin V1 is deprecated.
@joc-a joc-a force-pushed the joc/enable-new-dokka-plugin branch from 656942d to 901e71e Compare December 19, 2024 11:03
@joc-a
Copy link
Collaborator Author

joc-a commented Dec 19, 2024

Some additional steps probably need to be taken:

  1. Task dokkaHtmlMultiModule no longer exists in V2, so the github task for building api docs in docs-workflow.yml most likely needs to be changed as shown here.
  2. Current set-up isn't showing warnings, but the guide does suggest switching to dokka { } DSL (see 'Output Directory' point in this section)
  3. I'm not sure about this, but maybe changes suggested here need to also be made given that this is a multi-module project?

@bog-walk I did steps 1 and 2. I wanted to do step 2 before but I was not sure because there was no clear replacement for DokkaMultiModuleTask in the documentation. As for step 3, I'm not sure either. It seems to be working without it locally, but we can try, and then open another PR later if it doesn't.

@bog-walk
Copy link
Member

Sounds good to me 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants