Make dokka-core as compile time dependency and load it at runtime [229979216]

Fixed

Bug

Status Update

No update yet.

Description

bi...@google.com

created issue #1

Apr 21, 2022 04:04PM

This effort is to resolve the compatibility issue for users who use AGP and dokka gradle plugin at the same time.

Currently, AGP declares dokka-core as compile and runtime dependency and the dokka-core dependency version is bound with AGP. When the dokka-core dependency version are different between AGP and dokka-gradle-plugin, the desired dokka-core classes could possibly not be loaded which causes problems.

The recommended workaround for users who use dokka gradle plugin to generate docs is to exclude dokka-core from agp dependencies.

For reference https://github.com/Kotlin/dokka/issues/2415

Comments

je...@google.com <je...@google.com> #2Apr 21, 2022 06:12PM

Information redacted by Android Beta Feedback.

bi...@google.com <bi...@google.com> #3Apr 21, 2022 07:35PM

Thank you for reporting this issue. We have shared this with our product and engineering team and will update this issue with more information as it becomes available.

je...@google.com <je...@google.com> #4Apr 21, 2022 07:58PM

- Build Number: google/oriole_beta/oriole:14/AP21.240216.010/11529813:user/release-keys
(Note: It is the build when sending this report. For exact build reference, please see the attached bugreport.)

I got the March update but I still haven't 5G.

Debugging information
Servicios de Google Play
com.google.android.gms
Version 240713038 (24.07.13 (190400-607434947))
System App (Updated)

Android System WebView
com.google.android.webview
Version 626106433 (122.0.6261.64)
System App (Updated)

Network operator: Digi.Mobil
SIM operator: Digi.Mobil

Filed by Android Beta Feedback. Version (Updated): 2.40-betterbug.external_20240103_RC06 (DOGFOOD)
To learn more about our feedback process, please visit

https://developer.android.com/preview/feedback#feedback-app.

bi...@google.com <bi...@google.com> #5Apr 21, 2022 10:44PM

Information redacted by Android Beta Feedback.

bi...@google.com <bi...@google.com> #6Apr 23, 2022 01:42AM

- Build Number: google/oriole_beta/oriole:14/AP21.240305.005/11624884:user/release-keys
(Note: It is the build when sending this report. For exact build reference, please see the attached bugreport.)

I have gotten the April update and I still haven't 5G in my phone. That's disappointing!!
When will be it fixed?

Debugging information
Servicios de Google Play
com.google.android.gms
Version 240914038 (24.09.14 (190400-617895654))
System App (Updated)

Android System WebView
com.google.android.webview
Version 631204033 (123.0.6312.40)
System App (Updated)

Network operator: Digi.Mobil
SIM operator: Digi.Mobil

Filed by Android Beta Feedback. Version (Updated): 2.41-betterbug.external_20240221_RC01 (DOGFOOD)
To learn more about our feedback process, please visit

https://developer.android.com/preview/feedback#feedback-app.

bi...@google.com <bi...@google.com> #7Apr 23, 2022 01:59AM

Information redacted by Android Beta Feedback.

je...@google.com <je...@google.com> #8Apr 24, 2022 06:21PM

using reflection is not a silver bullet, if the API changes, the reflection calls will do too.

ca...@gmail.com <ca...@gmail.com> #9Apr 25, 2022 02:55PM

Comment has been deleted.

Message last modified on Apr 25, 2022 02:56PM

ig...@jetbrains.com <ig...@jetbrains.com> #10Apr 25, 2022 02:57PM

Please note that we (the dokka team) plan to integrate Dokka into the Kotlin Gradle plugin itself, so that docs generation is available out of the box.

We haven't started working on that yet, so there's no details I can share, but I'll try to keep you updated. Just thought you should know.

bi...@google.com <bi...@google.com> #11Apr 25, 2022 04:46PM

Thanks for letting us know! Do you have plan to integrate dokka into kotlin android gradle plugin?

Jerome, do you think we can let kotlin android plugin use variant api to provide the generated docs? (e.g. we create a dummy output and they "replace" it with their output.)

je...@google.com <je...@google.com> #12Apr 25, 2022 05:01PM

we don't need to create a dummy output, we can just declare the artifact type and optionally consume it if it is provided/there.

bi...@google.com <bi...@google.com> #13Apr 25, 2022 05:04PM

Our docs generation task is registered based on our dsl input, so the problem is how to let kotlin plugin know when to generate docs. By checking our dsl?

je...@google.com <je...@google.com> #14Apr 25, 2022 05:14PM

this relates to the work Ivan is trying to do with regard to KGP. I would be better that KGP offers the task and ways to configure it and we, AGP, register the task based on our DSL.

bi...@google.com <bi...@google.com> #15Apr 25, 2022 05:23PM

When we integrated dokka, we were thinking about whether to rely on dokka-core or configure the task from dokk-gradle-plugin. The reason why we didn't choose the dokka-gradle plugin is because the way how they configure tasks and wire up things is quite different from us and there were other issues in their plugin(e.g. config caching)

With KGP, I think it would be better as we basically are on the same page of adopting Gradle APIs and features.

ig...@jetbrains.com <ig...@jetbrains.com> #16Apr 26, 2022 06:22PM

> Do you have plan to integrate dokka into kotlin android gradle plugin?

Not that I'm aware of, no.

> I would be better that KGP offers the task and ways to configure it and we, AGP, register the task based on our DSL.

If AGP could use Dokka shipped with KGP that would be great I think. We'll keep this in mind when designing the implementation.

As soon as we have some sort of a rough timeline - I'll let you know. We'll also try to keep you in the loop and try to provide some sort of a preview so that we can integrate and find bugs early on.

au...@google.com <au...@google.com> #17May 12, 2022 03:31PM

One thing to consider here is to not add dokka-core directly to the classpath, but instead create a separate configuration/classpath/JVM process and only load it for the documentation task. That way, we will avoid all of the version collisions. AndroidX would also benefit from this as we currently explicitly drop dokka-core from AGP due to the same reason.

ga...@google.com <ga...@google.com> #18May 12, 2022 03:46PM

This should be fixed in http://ag/17989088, Dokka should not be in the AGP runtime classpath any more.

ey...@gmail.com <ey...@gmail.com> #19May 12, 2022 04:31PM

What version of AGP is that?

bi...@google.com <bi...@google.com> #20May 12, 2022 05:25PM

Marked as fixed.

Re #19, it should be in AGP 7.4-alpha01

Message last modified on May 12, 2022 05:25PM

ig...@jetbrains.com <ig...@jetbrains.com> #21May 23, 2022 10:37AM

> Re #19, it should be in AGP 7.4-alpha01

Hi! Thanks!

Is there any way this can be cherry picked into earlier versions? 7.2, 7.3? Or at least have an updated Dokka in the mean time? 1.4 is quite old and was still in alpha, so some strange bugs do occur, and more and more people keep hitting hard to debug errors as they update.

bi...@google.com <bi...@google.com> #22May 23, 2022 05:52PM

I think it is okay to cherry pick to 7.3 but it is too late for 7.2.

bi...@google.com <bi...@google.com> #23May 28, 2022 12:04AM

The cherry-pick(ag/18561238) to 7.3 is merged in.

Issue 229979216

Description

Issue summary

Comments

je...@google.com <je...@google.com> #2Apr 21, 2022 06:12PM

bi...@google.com <bi...@google.com> #3Apr 21, 2022 07:35PM

je...@google.com <je...@google.com> #4Apr 21, 2022 07:58PM

bi...@google.com <bi...@google.com> #5Apr 21, 2022 10:44PM

bi...@google.com <bi...@google.com> #6Apr 23, 2022 01:42AM

bi...@google.com <bi...@google.com> #7Apr 23, 2022 01:59AM

je...@google.com <je...@google.com> #8Apr 24, 2022 06:21PM

ca...@gmail.com <ca...@gmail.com> #9Apr 25, 2022 02:55PM

ig...@jetbrains.com <ig...@jetbrains.com> #10Apr 25, 2022 02:57PM

bi...@google.com <bi...@google.com> #11Apr 25, 2022 04:46PM

je...@google.com <je...@google.com> #12Apr 25, 2022 05:01PM

bi...@google.com <bi...@google.com> #13Apr 25, 2022 05:04PM

je...@google.com <je...@google.com> #14Apr 25, 2022 05:14PM

bi...@google.com <bi...@google.com> #15Apr 25, 2022 05:23PM

ig...@jetbrains.com <ig...@jetbrains.com> #16Apr 26, 2022 06:22PM

au...@google.com <au...@google.com> #17May 12, 2022 03:31PM

ga...@google.com <ga...@google.com> #18May 12, 2022 03:46PM

ey...@gmail.com <ey...@gmail.com> #19May 12, 2022 04:31PM

bi...@google.com <bi...@google.com> #20May 12, 2022 05:25PM

ig...@jetbrains.com <ig...@jetbrains.com> #21May 23, 2022 10:37AM

bi...@google.com <bi...@google.com> #22May 23, 2022 05:52PM

bi...@google.com <bi...@google.com> #23May 28, 2022 12:04AM

Add comment

Issue metadata