yegor256
commented
10 months ago @rultor please, try to merge, since 5 checks have passed
Closed renovate[bot] closed 10 months ago
yegor256
commented
10 months ago @rultor please, try to merge, since 5 checks have passed
rultor
This PR contains the following updates:
1.7.20->1.9.10Release Notes
Kotlin/dokka (org.jetbrains.dokka:dokka-maven-plugin)
### [`v1.9.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.10): 1.9.10 Beta [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.9.0...v1.9.10) #### General - Fix re-emerged code analysis concurrency issues which led to flaky builds ([#1599](https://togithub.com/Kotlin/dokka/issues/1599), [#3143](https://togithub.com/Kotlin/dokka/issues/3143)) - Preserve the order of collection items when deserializing Dokka's configuration ([#3006](https://togithub.com/Kotlin/dokka/issues/3006)). Thanks to [@eunwoop](https://togithub.com/eunwoop)! #### HTML format - Fix an indefinite loop in the script that resizes symbol signature blocks ([#3116](https://togithub.com/Kotlin/dokka/issues/3116)) #### Gradle - Fix resolution of platform dependencies for Kotlin 1.9 / Gradle 8 ([#3153](https://togithub.com/Kotlin/dokka/issues/3153), [#3147](https://togithub.com/Kotlin/dokka/issues/3147)) - Mark tasks as not compatible with the Gradle configuration cache ([#3070](https://togithub.com/Kotlin/dokka/issues/3070)). Thanks to [@BoD](https://togithub.com/BoD)! #### Java - Fix Java contravariant types being represented as covariant ([#3091](https://togithub.com/Kotlin/dokka/issues/3091)). Thanks to [@juliamcclellan](https://togithub.com/juliamcclellan)! ### [`v1.9.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.0): 1.9.0 Beta [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.8.20...v1.9.0) #### General improvements - Generate dedicated pages for type aliases and enhance their presentation ([https://github.com/Kotlin/dokka/issues/2862](https://togithub.com/Kotlin/dokka/issues/2862), [https://github.com/Kotlin/dokka/issues/2971](https://togithub.com/Kotlin/dokka/issues/2971)) - Add documentation for [Enum.entries](https://youtrack.jetbrains.com/issue/KT-48872) introduced in Kotlin 1.9.0 ([https://github.com/Kotlin/dokka/issues/2762](https://togithub.com/Kotlin/dokka/issues/2762)) #### HTML format This release is packed with enhancements and bugfixes that make your API reference docs mobile-friendly! You may find it a weird direction for improvement — we were just as surprised to find that almost 1/4 of Standard Library's API reference traffic is coming from mobile devices. Thanks to the Kotlin Website team, who contributed these improvements, Dokka now provides a solid experience to such visitors. ##### Improvements: - Significantly improve the mobile layout and overall responsiveness ([https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836), [https://github.com/Kotlin/dokka/pull/3021](https://togithub.com/Kotlin/dokka/pull/3021), [https://github.com/Kotlin/dokka/pull/3082](https://togithub.com/Kotlin/dokka/pull/3082), [https://github.com/Kotlin/dokka/pull/3018](https://togithub.com/Kotlin/dokka/pull/3018)) - Use JetBrains Sans as the primary text font ([https://github.com/Kotlin/dokka/pull/3017](https://togithub.com/Kotlin/dokka/pull/3017)) - Improve the experience of reading the documentation when JavaScript is disabled in the browser ([https://github.com/Kotlin/dokka/pull/3020](https://togithub.com/Kotlin/dokka/pull/3020), [https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836)) ##### Bugfixes - Fix a redundant dot in the path of search elements ([https://github.com/Kotlin/dokka/issues/2289](https://togithub.com/Kotlin/dokka/issues/2289)) - Fix unknown asset paths leaking into HTML body ([https://github.com/Kotlin/dokka/pull/3061](https://togithub.com/Kotlin/dokka/pull/3061)) - Fix invisible/hidden packages for modules with a space in the name ([https://github.com/Kotlin/dokka/issues/3011](https://togithub.com/Kotlin/dokka/issues/3011)) #### Java interoperability - Fix multi-param methods being classified as field setters ([https://github.com/Kotlin/dokka/issues/2992](https://togithub.com/Kotlin/dokka/issues/2992)) #### Javadoc format - Add basic support for `@author`, `@since` and `@return` tags ([https://github.com/Kotlin/dokka/issues/1770](https://togithub.com/Kotlin/dokka/issues/1770)). Thanks to [@irina-turova](https://togithub.com/irina-turova)! #### Other - Decompose Kotlin/Java analysis ([https://github.com/Kotlin/dokka/pull/3034](https://togithub.com/Kotlin/dokka/pull/3034)) - Improve copying base-frontend files between subprojects ([https://github.com/Kotlin/dokka/pull/2970](https://togithub.com/Kotlin/dokka/pull/2970)). Thanks to [@aSemy](https://togithub.com/aSemy)! *** #### Known problems Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see [https://github.com/Kotlin/dokka/issues/3153](https://togithub.com/Kotlin/dokka/issues/3153) for more details and workarounds. #### Breaking changes This release introduces some breaking changes that are expected to affect only a fraction of Dokka users. ##### HTML **Note:** this section only applies to those customizing Dokka's HTML format by overriding styles or HTML templates. If you are not doing any customizations, you may skip this section. To lay a solid foundation to making the HTML format responsive, some page layouts and many styles had to be changed in a backward-incompatible manner. If you are overriding `logo-styles.css` to provide your own header logo, please update it to be in line with the [new styles](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/logo-styles.css) - there is significantly less position hardcoding now. See [this example](https://togithub.com/Kotlin/dokka/blob/master/examples/gradle/dokka-customFormat-example/logo-styles.css) for how it can be done. If you are overriding `styles.css` with your own file, please update the baseline styles to the [latest](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/style.css), and see if anything is broken. If you get stuck with adapting your styles to the changes, the [diff](https://gist.github.com/IgnatBeresnev/0ef6a2db6aec49e6a43c12a2a9f287d0/revisions#diff-380b7b38760dd442e897eb0164c58f6a17da966ccaca6318017a468c163979b1) might help. If you are overriding `base.ftl` or `header.ftl` templates, please update them to the [latest](https://togithub.com/Kotlin/dokka/tree/1.9.0/plugins/base/src/main/resources/dokka/templates), and adapt your changes. ##### CLI runner Due to the analysis refactoring needed for the migration to K2 ([#3099](https://togithub.com/Kotlin/dokka/issues/3099)), the JARs required to run Dokka have slightly changed. The following JARs are **no longer supported** or published: - [dokka-analysis.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis) - [kotlin-analysis-intellij.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij) - [kotlin-analysis-compiler.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler) Please, replace them with a single JAR: - [analysis-kotlin-descriptors-1.9.0.jar](https://repo1.maven.org/maven2/org/jetbrains/dokka/analysis-kotlin-descriptors/1.9.0/) ##### Plugin API An internal refactoring of Dokka's analysis API was much needed for the migration to K2, leading to breaking changes in some cases. If your Dokka plugin compiles without any problems — you may ignore this information, you are likely not affected. If something doesn't compile or doesn't work anymore, please see [#3099](https://togithub.com/Kotlin/dokka/issues/3099) for more details. ### [`v1.8.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.8.20): 1.8.20 Beta [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.8.10...v1.8.20) ### Improvements - Update Kotlin Gradle Plugin to 1.8.10 and Android Gradle Plugin to 4.1.3. - Move the "Properties" block to be above functions inside the "Members" tab ([#2908](https://togithub.com/Kotlin/dokka/issues/2908)) - Make Javadoc tag parsing case-sensitive as per Javadoc specification ([#2907](https://togithub.com/Kotlin/dokka/issues/2907)) - Improve performance by reducing allocations and thus decreasing time spent in GC ([#2729](https://togithub.com/Kotlin/dokka/issues/2729)) ### Bugfixes - Fix unresolved links leading to declarations from another source set [#2878](https://togithub.com/Kotlin/dokka/issues/2878) - Fix Dokka not failing the build if there are errors ([#2934](https://togithub.com/Kotlin/dokka/issues/2934)), regression from 1.8.10. Thanks to [@jush](https://togithub.com/jush)! - Fix `TypeNotPresentException` thrown in projects without KGP ([#2890](https://togithub.com/Kotlin/dokka/issues/2890)), regression from 1.8.10. ### Gradle plugin - Start using `kotlin-dsl` plugin ([#2702](https://togithub.com/Kotlin/dokka/issues/2702), [#2833](https://togithub.com/Kotlin/dokka/issues/2833)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Use Gradle filesystem types for task properties and apply default values lazily ([#2707](https://togithub.com/Kotlin/dokka/issues/2707), [#2983](https://togithub.com/Kotlin/dokka/issues/2983)). Thanks to [@aSemy](https://togithub.com/aSemy)! ### Plugin API - Change the default logging level of console apps (`DokkaConsoleLogger`) to `PROGRESS` ([#2871](https://togithub.com/Kotlin/dokka/issues/2871)) - Introduce `@InternalDokkaApi` annotation ([#2904](https://togithub.com/Kotlin/dokka/issues/2904)) - Mark various utility API as Dokka-internal ([#2937](https://togithub.com/Kotlin/dokka/issues/2937)) ### Infrastructure Big thanks to [@aSemy](https://togithub.com/aSemy), [@Goooler](https://togithub.com/Goooler) and [@3flex](https://togithub.com/3flex) for their valuable contributions and for improving the internal developer experience when working on Dokka! - Use convention plugins to configure the subprojects ([#2704](https://togithub.com/Kotlin/dokka/issues/2704) by [@aSemy](https://togithub.com/aSemy)) - Use Gradle Version Catalog and type-safe project dependencies ([#2884](https://togithub.com/Kotlin/dokka/issues/2884) by [@aSemy](https://togithub.com/aSemy)) - Migrate `buildSrc` to a composite build ([#2912](https://togithub.com/Kotlin/dokka/issues/2912) by [@Goooler](https://togithub.com/Goooler)) - Tidy up build configurations and project files ([#2911](https://togithub.com/Kotlin/dokka/issues/2911), [#2930](https://togithub.com/Kotlin/dokka/issues/2930), [#2909](https://togithub.com/Kotlin/dokka/issues/2909), [#2946](https://togithub.com/Kotlin/dokka/issues/2946), [#2910](https://togithub.com/Kotlin/dokka/issues/2910), [#2705](https://togithub.com/Kotlin/dokka/issues/2705) by [@aSemy](https://togithub.com/aSemy)) - Execute unit tests in parallel ([#2953](https://togithub.com/Kotlin/dokka/issues/2953) by [@Goooler](https://togithub.com/Goooler)) - Add the ability to use different Java versions for build and test tasks ([#2918](https://togithub.com/Kotlin/dokka/issues/2918) by [@aSemy](https://togithub.com/aSemy)) - Add reproducible archive build config ([#2947](https://togithub.com/Kotlin/dokka/issues/2947) by [@aSemy](https://togithub.com/aSemy)) - Configure Kotlin compiler options lazily ([#2883](https://togithub.com/Kotlin/dokka/issues/2883) by [@Goooler](https://togithub.com/Goooler)) - Improve GitHub Actions workflows ([#2939](https://togithub.com/Kotlin/dokka/issues/2939), [#2938](https://togithub.com/Kotlin/dokka/issues/2938) by [@Goooler](https://togithub.com/Goooler)) - Stop testing on Java 15 as it has reached EOL ([#2892](https://togithub.com/Kotlin/dokka/issues/2892) by [@3flex](https://togithub.com/3flex)) - Remove a workaround for a fixed Gradle issue ([#2891](https://togithub.com/Kotlin/dokka/issues/2891) by [@3flex](https://togithub.com/3flex)) ### Documentation - Add informational badges to the main `README.md` ([#2940](https://togithub.com/Kotlin/dokka/issues/2940)). Thanks to [@Goooler](https://togithub.com/Goooler)! - Fix typos, inconsistencies and incorrect links in documentation ([#2979](https://togithub.com/Kotlin/dokka/issues/2979), [#2973](https://togithub.com/Kotlin/dokka/issues/2973), [#2952](https://togithub.com/Kotlin/dokka/issues/2952)). Thanks to [@LiYing2010](https://togithub.com/LiYing2010), [@strangesource](https://togithub.com/strangesource) and [@ansman](https://togithub.com/ansman)! - Add more information about the infrastructure to `CONTRIBUTING.md` ([#2952](https://togithub.com/Kotlin/dokka/issues/2952)) ### Security - Bump npm dependencies to address various vulnerabilities ([#2894](https://togithub.com/Kotlin/dokka/issues/2894), [#2923](https://togithub.com/Kotlin/dokka/issues/2923)) ### Other - Update publication POM links to https ([#2931](https://togithub.com/Kotlin/dokka/issues/2931)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Tidy up Gradle example projects and warning suppressions ([#2916](https://togithub.com/Kotlin/dokka/issues/2916), [#2975](https://togithub.com/Kotlin/dokka/issues/2975)). Thanks to [@aSemy](https://togithub.com/aSemy)! ### [`v1.8.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.8.10): 1.8.10 Beta [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.7.20...v1.8.10) Dokka's documentation has been entirely rewritten and can now be found on [kotlinlang.org](https://kotlinlang.org/docs/dokka-introduction.html): - More examples, including Groovy DSL for Gradle project configuration - More guidelines to help beginners - More details for complex projects **Note**: Version 1.8.0 was skipped due to a Metaspace memory leak in Kotlin's reflection ([KT-56093](https://youtrack.jetbrains.com/issue/KT-56093)). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0. #### Improvements - Revise project documentation and examples ([#2728](https://togithub.com/Kotlin/dokka/issues/2728), [#2737](https://togithub.com/Kotlin/dokka/issues/2737), [#2736](https://togithub.com/Kotlin/dokka/issues/2736)). Thanks to [@sarahhaggarty](https://togithub.com/sarahhaggarty) for helping! - Support generating documentation for Kotlin/Wasm projects ([#2814](https://togithub.com/Kotlin/dokka/issues/2814)). Thanks to [@igoriakovlev](https://togithub.com/igoriakovlev)! - Move the contents of `Inheritors`, `Parameters`, `See also` and `Samples` tabs into the main declaration description ([#2688](https://togithub.com/Kotlin/dokka/issues/2688)). - Add `Members` and `Members & Extensions` tabs to class-like declaration pages ([#2764](https://togithub.com/Kotlin/dokka/issues/2764)). - Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. ([#2847](https://togithub.com/Kotlin/dokka/issues/2847)). - Generate the default no-arg constructor for Java declarations ([#2765](https://togithub.com/Kotlin/dokka/issues/2765)). #### Bugfixes - Fixed analysis environment not being properly disposed ([#2755](https://togithub.com/Kotlin/dokka/issues/2755)). - Fixed nondeterministic sorting of function/property overloads ([#2784](https://togithub.com/Kotlin/dokka/issues/2784)). - Fixed inconsistent alphabetical order of element groups in index and navigation ([#2861](https://togithub.com/Kotlin/dokka/issues/2861)). - Fixed constructors being rendered as functions ([#2689](https://togithub.com/Kotlin/dokka/issues/2689)). - Fixed default values for `var` properties being displayed ([#2717](https://togithub.com/Kotlin/dokka/issues/2717)). - Fixed source links leading to the KDoc instead of the declaration ([#2724](https://togithub.com/Kotlin/dokka/issues/2724)). - Fixed thread-safety issues in `DokkaLogger` ([#2827](https://togithub.com/Kotlin/dokka/issues/2827)). - Fixed documentation not being inherited in case of diamond inheritance ([#2686](https://togithub.com/Kotlin/dokka/issues/2686)). ##### Gradle Plugin - Fixed `NoSuchMethodError` when running under Gradle 8 ([#2796](https://togithub.com/Kotlin/dokka/issues/2796)). - Fixed possible metaspace leaks due to external thread locals not being disposed ([#2678](https://togithub.com/Kotlin/dokka/issues/2678)). - Fixed premature initialization of `outputDirectory` input property ([#556](https://togithub.com/Kotlin/dokka/issues/556)). - Fixed premature initialization of `moduleVersion` input property ([#2799](https://togithub.com/Kotlin/dokka/issues/2799)). Thanks to [@JavierSegoviaCordoba](https://togithub.com/JavierSegoviaCordoba)! - Fixed unnecessary snapshotting of source link directory input which led to performance problems ([#2807](https://togithub.com/Kotlin/dokka/issues/2807)). - Fixed missing group and description for `MultiModule` tasks ([#2806](https://togithub.com/Kotlin/dokka/issues/2806)). Thanks to [@TWiStErRob](https://togithub.com/TWiStErRob)! ##### Javadoc - Fixed truncation of module and package description after the first sentence ([#2055](https://togithub.com/Kotlin/dokka/issues/2055)). Thanks to [@BlackAnubis7](https://togithub.com/BlackAnubis7)! - Fixed rendering of empty/useless Kotlin companion objects ([#200](https://togithub.com/Kotlin/dokka/issues/200), [#2086](https://togithub.com/Kotlin/dokka/issues/2086)) - Fixed leaking configuration/environment details in generated links ([#2803](https://togithub.com/Kotlin/dokka/issues/2803)). - Fixed incorrect links when `javadoc.jar` produced by Dokka is imported into IntelliJ IDEA / Android Studio ([#2734](https://togithub.com/Kotlin/dokka/issues/2734)). Thanks to [@bomberaya](https://togithub.com/bomberaya)! #### Plugin API - Mark Plugin API as experimental ([#2716](https://togithub.com/Kotlin/dokka/issues/2716)). #### Infrastructure - Enable Gradle build cache, and add caching of Maven dependencies for GitHub Actions ([#2711](https://togithub.com/Kotlin/dokka/issues/2711), [#2722](https://togithub.com/Kotlin/dokka/issues/2722)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Add concurrency cancellation for build/test GitHub Actions ([#2710](https://togithub.com/Kotlin/dokka/issues/2710)). Thanks to [@aSemy](https://togithub.com/aSemy)! #### Other - Update `jackson-databind` to avoid CVE-2022-42003 ([#2733](https://togithub.com/Kotlin/dokka/issues/2733)). Thanks to [@ryanlewis](https://togithub.com/ryanlewis)! - Update `Jsoup` to avoid CVE-2022-36033 ([#2772](https://togithub.com/Kotlin/dokka/issues/2772)). - Deprecate methods for adding/removing task dependencies in Dokka's Gradle plugin ([#2857](https://togithub.com/Kotlin/dokka/issues/2857)). - Documentation improvements and fixes ([#2719](https://togithub.com/Kotlin/dokka/issues/2719), [#2718](https://togithub.com/Kotlin/dokka/issues/2718), [#2744](https://togithub.com/Kotlin/dokka/issues/2744)). Thanks to [@SimonMarquis](https://togithub.com/SimonMarquis) and [@ansman](https://togithub.com/ansman)!Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 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 this update again.
This PR has been generated by Mend Renovate. View repository job log here.