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

Regression testing of K2 analysis, first iteration [Kotlin/JVM] #3328

Closed
IgnatBeresnev opened this issue Nov 10, 2023 · 1 comment
Closed
Assignees
Labels
topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Milestone

Comments

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Nov 10, 2023

This issue is part of a larger issue: Migrate Dokka's analysis to K2 compiler (#2888).

Goal

The goal of the first iteration of regression testing K2 is to identify the major and most obvious problems that need to be fixed. Once the uncovered problems are fixed, the second iteration can focus on the finer details and corner cases.

Things to keep in mind:

  • The focus should be on Kotlin/JVM and Java projects. KMP can also be tested if there's time, but it shouldn't be too much of a blocker.
  • The HTML format is the primary one, but other formats (esp. Javadoc) can also be tested if there's time for it.
  • The produced HTML pages and their content should ideally be the same as produced by K1, but there might be insignificant (from the user's perspective) differences.
  • Java interop should be checked.
  • Dokka should work with Android projects (AGP).
  • Running Dokka on Linux / Windows / Macos should work equally well.
  • Dokka should be compatible with different versions of Kotlin (KGP), there shouldn't be any difference.

Current state

Additional context

  • Stability of Dokka's K2 analysis mostly depends on the stability of the K2 IDE plugin, because they share a lot of the underlying logic (Analysis API).
  • The majority of bugs you see in K2 IDE are expected to be relevant for Dokka as well, and vice versa.
@IgnatBeresnev IgnatBeresnev changed the title Current state of K2 K2 testing Nov 10, 2023
@atyrin atyrin self-assigned this Nov 10, 2023
@vmishenev vmishenev added the topic: K2 Issues / PRs that are related to the K2 migration. See #2888 label Nov 15, 2023
@IgnatBeresnev IgnatBeresnev changed the title K2 testing Regression testing of K2 analysis, first iteration [Kotlin/JVM] Dec 12, 2023
@atyrin
Copy link
Contributor

atyrin commented Dec 18, 2023

Done. Except for the point about different host OSs for running Dokka, I doubt there are some changes, and it is a priority. I'll move the check to the next iteration.

@IgnatBeresnev IgnatBeresnev added this to the Dokka 1.9.20 milestone Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Projects
None yet
Development

No branches or pull requests

3 participants