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-base to v1.9.20 #40

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 5, 2023

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.dokka:dokka-base 1.8.10 -> 1.9.20 age adoption passing confidence

Release Notes

Kotlin/dokka (org.jetbrains.dokka:dokka-base)

v1.9.20: 1.9.20

General bugfixes

HTML format

Runners

Gradle Plugin
Maven Plugin
CLI runner

Plugin API

Other:

See Dokka 1.9.20 milestone for the list of all changes.

v1.9.10: 1.9.10

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

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

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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title Update dependency org.jetbrains.dokka:dokka-base to v1.8.20 Update dependency org.jetbrains.dokka:dokka-base to v1.9.0 Aug 31, 2023
@renovate renovate bot force-pushed the renovate/org.jetbrains.dokka-dokka-base-1.x branch from 08966ab to dc270b9 Compare August 31, 2023 22:54
@renovate renovate bot force-pushed the renovate/org.jetbrains.dokka-dokka-base-1.x branch from dc270b9 to 44613c0 Compare October 16, 2023 15:38
@renovate renovate bot changed the title Update dependency org.jetbrains.dokka:dokka-base to v1.9.0 Update dependency org.jetbrains.dokka:dokka-base to v1.9.10 Oct 16, 2023
@renovate renovate bot changed the title Update dependency org.jetbrains.dokka:dokka-base to v1.9.10 Update dependency org.jetbrains.dokka:dokka-base to v1.9.20 Mar 4, 2024
@renovate renovate bot force-pushed the renovate/org.jetbrains.dokka-dokka-base-1.x branch from 44613c0 to 6633d2a Compare March 4, 2024 16:20
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.

0 participants