-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
KTOR-8289 Update dokka to v2 (major) #4555
Merged
Merged
+71
−22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7392116
to
68d114e
Compare
68d114e
to
2f079af
Compare
2f079af
to
9ca796a
Compare
9ca796a
to
fde9825
Compare
Edited/Blocked NotificationRenovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR. You can manually request rebase by checking the rebase/retry box above. |
osipxd
reviewed
Mar 7, 2025
b816c9e
to
8d0b1d9
Compare
bjhham
approved these changes
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.9.20
->2.0.0
1.9.20
->2.0.0
Release Notes
Kotlin/dokka (org.jetbrains.dokka:versioning-plugin)
v2.0.0
: 2.0.0Dokka 2.0.0 focuses on simplifying configuration and preparing for support of future Kotlin language features. Key highlights include:
More details about each of the changes below. See Dokka 2.0.0 milestone for the list of all changes.
Dokka's Gradle plugin v2 based on Dokkatoo
Dokka 2.0.0 introduces significant improvements to Dokka Gradle plugin, aligning more closely with Gradle best practices:
Changes from Dokka 2.0.0-Beta
dokkaPublicationDirectory
tobasePublicationsDirectory
(https://github.com/Kotlin/dokka/pull/3876)dokkaModuleDirectory
, and mark as internal (https://github.com/Kotlin/dokka/pull/3880)dokkaGenerate
ondokkaGenerateModule*
(https://github.com/Kotlin/dokka/pull/3920)Dokka's K2 analysis
Dokka 2.0.0 introduces K2 analysis, which is currently in an experimental stage. Dokka's K2 analysis leverages Kotlin's K2 compiler frontend for analysing code and uses the same shared Analysis API, which is used in IntelliJ IDEA’s K2 mode. The output with K2 analysis should mostly match that of K1 analysis, but there may be minor differences. We are actively working towards stabilizing K2 analysis and are planning to enable K2 analysis by default in future.
To opt in to Dokka's K2 analysis, add the following flag to your project's
gradle.properties
file:org.jetbrains.dokka.experimental.tryK2=true
Known limitations:
We would greatly value your feedback if you encounter any of these limitations.
Potential differences between the outputs of K1 and K2:
While the output of K2 analysis aims to align with K1, there are some differences to be aware of:
HTML format
Dokka 2.0.0 introduces some changes to HTML output. We updated the structure of some elements and classes, particularly in the navigation and sidebar, to improve accessibility and simplify maintenance. These changes only affect you if you previously customized Dokka styles.
navigation--inner
andnavigation-title
.versions-dropdown
to make them more accessible.navigation-controls--homepage
to improve consistency. For example, it’s now callednavigation-controls--btn_homepage
.For more information, see the pull request.
The easiest way to update your current templates is to adjust the new templates to your needs.
Bugfixes
Other changes
Feedback
We would appreciate your feedback!
Full Changelog: Kotlin/dokka@v1.9.20...v2.0.0
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - "* 0-4,22-23 * * 1-5,* * * * 0,6" (UTC).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR was generated by Mend Renovate. View the repository job log.