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

Update dependency org.jetbrains.dokka:dokka-maven-plugin to v1.9.10 #145

Merged
merged 1 commit into from
Jan 16, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 16, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.dokka:dokka-maven-plugin 1.7.20 -> 1.9.10 age adoption passing confidence

Release Notes

Kotlin/dokka (org.jetbrains.dokka:dokka-maven-plugin)

v1.9.10: 1.9.10

Compare Source

General
  • Fix re-emerged code analysis concurrency issues which led to flaky builds (#​1599, #​3143)
  • Preserve the order of collection items when deserializing Dokka's configuration (#​3006). Thanks to @​eunwoop!
HTML format
  • Fix an indefinite loop in the script that resizes symbol signature blocks (#​3116)
Gradle
  • Fix resolution of platform dependencies for Kotlin 1.9 / Gradle 8 (#​3153, #​3147)
  • Mark tasks as not compatible with the Gradle configuration cache (#​3070). Thanks to @​BoD!
Java

v1.9.0: 1.9.0

Compare Source

General improvements
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:
Bugfixes
Java interoperability
Javadoc format
Other

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

Compare Source

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

Plugin API

  • Change the default logging level of console apps (DokkaConsoleLogger) to PROGRESS (#​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!

Documentation

Security

Other

v1.8.10: 1.8.10 Beta

Compare Source

Dokka's documentation has been entirely rewritten and can now be found on kotlinlang.org:

  • 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). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0.

Improvements

  • Revise project documentation and examples (#​2728, #​2737, #​2736). Thanks to @​sarahhaggarty for helping!
  • Support generating documentation for Kotlin/Wasm projects (#​2814). Thanks to @​igoriakovlev!
  • Move the contents of Inheritors, Parameters, See also and Samples tabs into the main declaration description (#​2688).
  • Add Members and Members & Extensions tabs to class-like declaration pages (#​2764).
  • Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. (#​2847).
  • Generate the default no-arg constructor for Java declarations (#​2765).

Bugfixes

  • Fixed analysis environment not being properly disposed (#​2755).
  • Fixed nondeterministic sorting of function/property overloads (#​2784).
  • Fixed inconsistent alphabetical order of element groups in index and navigation (#​2861).
  • Fixed constructors being rendered as functions (#​2689).
  • Fixed default values for var properties being displayed (#​2717).
  • Fixed source links leading to the KDoc instead of the declaration (#​2724).
  • Fixed thread-safety issues in DokkaLogger (#​2827).
  • Fixed documentation not being inherited in case of diamond inheritance (#​2686).
Gradle Plugin
  • Fixed NoSuchMethodError when running under Gradle 8 (#​2796).
  • Fixed possible metaspace leaks due to external thread locals not being disposed (#​2678).
  • Fixed premature initialization of outputDirectory input property (#​556).
  • Fixed premature initialization of moduleVersion input property (#​2799). Thanks to @​JavierSegoviaCordoba!
  • Fixed unnecessary snapshotting of source link directory input which led to performance problems (#​2807).
  • Fixed missing group and description for MultiModule tasks (#​2806). Thanks to @​TWiStErRob!
Javadoc
  • Fixed truncation of module and package description after the first sentence (#​2055). Thanks to @​BlackAnubis7!
  • Fixed rendering of empty/useless Kotlin companion objects (#​200, #​2086)
  • Fixed leaking configuration/environment details in generated links (#​2803).
  • Fixed incorrect links when javadoc.jar produced by Dokka is imported into IntelliJ IDEA / Android Studio (#​2734). Thanks to @​bomberaya!

Plugin API

  • Mark Plugin API as experimental (#​2716).

Infrastructure

  • Enable Gradle build cache, and add caching of Maven dependencies for GitHub Actions (#​2711, #​2722). Thanks to @​aSemy!
  • Add concurrency cancellation for build/test GitHub Actions (#​2710). Thanks to @​aSemy!

Other


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.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@yegor256
Copy link
Member

@rultor please, try to merge, since 3 checks have passed

@rultor
Copy link
Contributor

rultor commented Jan 16, 2024

@rultor please, try to merge, since 3 checks have passed

@yegor256 OK, I'll try to merge now. You can check the progress of the merge here

@rultor rultor merged commit e2c45f7 into master Jan 16, 2024
3 checks passed
@rultor
Copy link
Contributor

rultor commented Jan 16, 2024

@rultor please, try to merge, since 3 checks have passed

@yegor256 Done! FYI, the full log is here (took me 3min)

@renovate renovate bot deleted the renovate/dokka.version branch January 16, 2024 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants