Update DGP migration opt-in flags and messages #3736
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adam-enko
added
the
runner: Gradle plugin
5 tasks
- Re-write the Dokka Gradle Plugin v1 & v2 messages. - Update the opt-in flag for v2. - Create a BuildService, so the messages are only logged once per project.
adam-enko
force-pushed
the
adam/feat/OSIP-355/update-dokkatoo-optin-flags
branch
from
47824c0 to
608937b
Compare
adam-enko
changed the title
I want to add more opt-in flags in the future, and the pattern of '$prop.quiet=true' is easier to read, understand, and more robust. E.g. 'dokka.enableK2.quiet=true' is nicer to read than 'dokka.suppressK2Message=true'.
whyoleg
reviewed
Aug 14, 2024
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
Tapchicoma
reviewed
Aug 14, 2024
dokka-runners/dokka-gradle-plugin/src/classicMain/kotlin/DokkaClassicPlugin.kt
Show resolved
Hide resolved
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt
Outdated
Show resolved
Hide resolved
- Re-register the BuildService if it fails. Mark the first successfully registered BuildService as 'primary'. Only 'primary' BuildServices will log user-facing messages.
- Update MigrationMessagesTest to test BuildService classloader issues.
- Rename flag properties for consistency.
- Add `.nowarn` and `.noWarn` variants, because I really don't want to be constantly nagged by spellcheck.
- use `lazy(SYNCHRONIZED) {}` to better control logging, only log when necessary, and to avoid potential parallel issues.
Avoid using `Properties()` because it needlessly escapes values, doesn't order values, and adds a timestamp.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continued from #3695 (comment)
gradle.propertiesin a test project.tl;dr:
org.jetbrains.dokka.experimental.gradlePlugin.enableV2=trueto opt-in for V2.org.jetbrains.dokka.experimental.gradlePlugin.enableV2.noWarn=trueto suppress the message.KT-70655