Migrate to DGPv2 #3005
Migrate to DGPv2 #3005
Conversation
| } | ||
| dokka.dokkaSourceSets.configureEach { | ||
| externalDocumentationLinks.register("kotlinx-io") { | ||
| url("https://kotlinlang.org/api/kotlinx-io/") |
There was a problem hiding this comment.
JIC: old URL is not accessible anymore
There was a problem hiding this comment.
Local build gives me Failed to download package-list from https://kotlinlang.org/api/kotlinx-io/package-list, this might suggest that remote resource is not available, module is empty or dokka output got corrupted, and Source/Sink declarations in the doc are not linked, despite URL being available
There was a problem hiding this comment.
Hm, that looks strange, local build works fine on my side.
I can make it use the local package list (downloaded), as it was before for okio. The only case when the package list will become outdated is when a package is added or removed, so probably it should not be a big deal here to just use the local package list.
WDYT?
There was a problem hiding this comment.
I've added local package lists for both kotlinx-io and okio, so that the build will be less dependent on network failures.
JIC: Dokka by default still relies on downloading the package list of the stdlib.
| @@ -52,11 +52,4 @@ kotlin { | |||
| } | |||
| } | |||
|
|
|||
| // This task should be disabled because of no need to build and publish intermediate JsWasm sourceset | |||
| tasks.whenTaskAdded { | |||
There was a problem hiding this comment.
This workaround is not needed, locally build and publish tasks works find without it, but it caused some issues locally at my side.
I can revert it, if you know the reason why it's needed
There was a problem hiding this comment.
cc @igoriakovlev maybe this workaround is not needed anymore?
There was a problem hiding this comment.
JIC, I've now additionally checked, and ./gradlew compileJsWasmMainKotlinMetadata executed successfully, so we don't need this hack anymore.
I believe initially, this source set contained some declarations that were available in JS and wasm-js targets, but without a shared declaration, as there is no shared source set in the stdlib for JS and wasm-js.
But I don't see anything like this now.
|
|
||
| sourceLink { | ||
| localDirectory.set(rootDir) | ||
| perPackageOption { |
There was a problem hiding this comment.
Previously, there were multiple perPackageOption - most of them are obsolete or separate configurations for internal package. So, obsolete were removed and internal are handled by one regex now
There was a problem hiding this comment.
Are @Deprecated declarations skipped now by default?
There was a problem hiding this comment.
Nope, only HIDDEN ones. Looks like I missed the flag during refactoring
Is it desirable behavior to skip deprecated with WARNING and ERROR declarations in all modules?
There was a problem hiding this comment.
I've brought back skipDeprecated = true
| localDirectory.set(rootDir) | ||
| perPackageOption { | ||
| matchingRegex = ".*\\.internal(\\..*)?" | ||
| suppress = true |
There was a problem hiding this comment.
reportUndocumented = false ?
There was a problem hiding this comment.
There is no need, as suppressed packages are skipped during analysis, and so no warnings will be present for them
Migrate to new Dokka Gradle Plugin (migration guide)
Because of the Gradle task name change, the kotlinlang deploy configuration should also be updated.
Related: JetBrains/kotlin-web-site#4851