Skip to content

Migrate to Dokka plugin V2 (#2101) #2113

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

Merged
merged 1 commit into from
Apr 16, 2025
Merged

Migrate to Dokka plugin V2 (#2101) #2113

merged 1 commit into from
Apr 16, 2025

Conversation

IRus
Copy link
Contributor

@IRus IRus commented Apr 16, 2025

  • docs/changelog.md has been updated if applicable.
    • Changes not visible to library consumers, such as build script, documentation, or test code updates, don't need to
      be added to the changelog.
  • CLA signed.

@IRus
Copy link
Contributor Author

IRus commented Apr 16, 2025

Plugin message after adding org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers:

warning: Dokka Gradle plugin V2 migration helpers are enabled
    
    Thank you for migrating to Dokka Gradle plugin V2!
    Migration is in progress, and helpers have been enabled.
    To learn about migrating read the migration guide https://kotl.in/dokka-gradle-migration
    
    Once you have finished migrating disable the migration helpers by adding
        org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
    to your project's `gradle.properties` file.
    
    We would appreciate your feedback!
     - Please report any feedback or problems https://kotl.in/dokka-issues
     - Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)
    

After migration to v2 org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled:

    Thank you for enabling Dokka Gradle plugin V2!
    To learn about migrating read the migration guide https://kotl.in/dokka-gradle-migration
    
    We would appreciate your feedback!
     - Please report any feedback or problems https://kotl.in/dokka-issues
     - Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)
    
    You can suppress this message by adding
        org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
    to your project's `gradle.properties` file.

And finally after adding org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true clean logs

Copy link
Collaborator

@Egorand Egorand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you!

@IRus
Copy link
Contributor Author

IRus commented Apr 16, 2025

I generated the documentation using the old dokkaHtml task and plugin, as well as the new task. I compared them visually and didn’t find any differences.

@Egorand Egorand merged commit 0df47ed into square:main Apr 16, 2025
4 checks passed
@IRus IRus deleted the feature/2101 branch April 16, 2025 12:50
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.

2 participants