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 plugin org.jetbrains.dokka to v1.9.0 #1329

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 31, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.dokka 1.8.20 -> 1.9.0 age adoption passing confidence

Release Notes

Kotlin/dokka (org.jetbrains.dokka)

v1.9.0: 1.9.0 Beta

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.


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.

@renovate renovate bot requested a review from a team as a code owner August 31, 2023 23:06
@renovate renovate bot added the Dependencies [PRs only] Indicates a dependency update label Aug 31, 2023
@renovate renovate bot force-pushed the renovate/dokka_version branch 3 times, most recently from cfe23f9 to a4db17e Compare September 7, 2023 09:50
@jreij jreij merged commit bf71c93 into develop Sep 7, 2023
5 checks passed
@jreij jreij deleted the renovate/dokka_version branch September 7, 2023 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies [PRs only] Indicates a dependency update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant