YCharts
YCharts copied to clipboard
Update others
This PR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
org.jlleitschuh.gradle.ktlint | 11.3.1 -> 11.6.0 |
||||
org.jetbrains.dokka | 1.8.10 -> 1.9.0 |
||||
org.jetbrains.dokka:dokka-gradle-plugin | 1.8.10 -> 1.9.0 |
||||
org.sonarqube | 4.0.0.2929 -> 4.4.0.3356 |
Release Notes
Kotlin/dokka (org.jetbrains.dokka)
v1.9.0
: 1.9.0 Beta
General improvements
- Generate dedicated pages for type aliases and enhance their presentation (https://github.com/Kotlin/dokka/issues/2862, https://github.com/Kotlin/dokka/issues/2971)
- Add documentation for Enum.entries introduced in Kotlin 1.9.0 (https://github.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://github.com/Kotlin/dokka/pull/3021, https://github.com/Kotlin/dokka/pull/3082, https://github.com/Kotlin/dokka/pull/3018)
- Use JetBrains Sans as the primary text font (https://github.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://github.com/Kotlin/dokka/pull/2836)
Bugfixes
- Fix a redundant dot in the path of search elements (https://github.com/Kotlin/dokka/issues/2289)
- Fix unknown asset paths leaking into HTML body (https://github.com/Kotlin/dokka/pull/3061)
- Fix invisible/hidden packages for modules with a space in the name (https://github.com/Kotlin/dokka/issues/3011)
Java interoperability
- Fix multi-param methods being classified as field setters (https://github.com/Kotlin/dokka/issues/2992)
Javadoc format
- Add basic support for
@author
,@since
and@return
tags (https://github.com/Kotlin/dokka/issues/1770). Thanks to @irina-turova!
Other
- Decompose Kotlin/Java analysis (https://github.com/Kotlin/dokka/pull/3034)
- Improve copying base-frontend files between subprojects (https://github.com/Kotlin/dokka/pull/2970). Thanks to @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 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 - there is significantly less position hardcoding now. See this example for how it can be done.
If you are overriding styles.css
with your own file, please update the baseline styles to the latest, and see if anything is broken. If you get stuck with adapting your styles to the changes, the diff might help.
If you are overriding base.ftl
or header.ftl
templates, please update them to the latest, and adapt your changes.
CLI runner
Due to the analysis refactoring needed for the migration to K2 (#3099), the JARs required to run Dokka have slightly changed.
The following JARs are no longer supported or published:
Please, replace them with a single JAR:
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 for more details.
v1.8.20
: 1.8.20 Beta
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)
- Make Javadoc tag parsing case-sensitive as per Javadoc specification (#2907)
- Improve performance by reducing allocations and thus decreasing time spent in GC (#2729)
Bugfixes
- Fix unresolved links leading to declarations from another source set #2878
- Fix Dokka not failing the build if there are errors (#2934), regression from 1.8.10. Thanks to @jush!
- Fix
TypeNotPresentException
thrown in projects without KGP (#2890), regression from 1.8.10.
Gradle plugin
- Start using
kotlin-dsl
plugin (#2702, #2833). Thanks to @aSemy! - Use Gradle filesystem types for task properties and apply default values lazily (#2707, #2983). Thanks to @aSemy!
Plugin API
- Change the default logging level of console apps (
DokkaConsoleLogger
) toPROGRESS
(#2871) - Introduce
@InternalDokkaApi
annotation (#2904) - Mark various utility API as Dokka-internal (#2937)
Infrastructure
Big thanks to @aSemy, @Goooler and @3flex for their valuable contributions and for improving the internal developer experience when working on Dokka!
- Use convention plugins to configure the subprojects (#2704 by @aSemy)
- Use Gradle Version Catalog and type-safe project dependencies (#2884 by @aSemy)
- Migrate
buildSrc
to a composite build (#2912 by @Goooler) - Tidy up build configurations and project files (#2911, #2930, #2909, #2946, #2910, #2705 by @aSemy)
- Execute unit tests in parallel (#2953 by @Goooler)
- Add the ability to use different Java versions for build and test tasks (#2918 by @aSemy)
- Add reproducible archive build config (#2947 by @aSemy)
- Configure Kotlin compiler options lazily (#2883 by @Goooler)
- Improve GitHub Actions workflows (#2939, #2938 by @Goooler)
- Stop testing on Java 15 as it has reached EOL (#2892 by @3flex)
- Remove a workaround for a fixed Gradle issue (#2891 by @3flex)
Documentation
- Add informational badges to the main
README.md
(#2940). Thanks to @Goooler! - Fix typos, inconsistencies and incorrect links in documentation (#2979, #2973, #2952). Thanks to @LiYing2010, @strangesource and @ansman!
- Add more information about the infrastructure to
CONTRIBUTING.md
(#2952)
Security
Other
Configuration
📅 Schedule: Branch creation - "on the first day of the month" (UTC), 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
- [ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.