Skip to content

Conversation

jimlyas
Copy link

@jimlyas jimlyas commented Sep 11, 2025

Description

This PR include:

  • Use version catalog for applying gradle plugin
  • Removing unused entry in version catalog
  • Removing docs module and instead setup dokka at the root project

For documentation using dokka, I think it's unnecessary creating a module just to trigger task for documentation generation.

Now the gradle task can be triggered from the root project like this:

image

And the documentation will be generated here:

image

Validation

With this changes, the code still run as intended.

Screen.Recording.2025-09-11.at.09.13.07.mov

Jimly Asshiddiqy added 3 commits September 11, 2025 09:15
- Use version catalog for applying gradle plugin
- Removing unused entry in version catalog
- Removing docs module and instead setup dokka at the root project
- Bump JVM target from 1.8 to 21
- Update java version in github action
- Update github action for generate_dokka.yml
Copy link
Collaborator

@fire-light42 fire-light42 left a comment

Choose a reason for hiding this comment

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

Looks good code-wise, but I am unsure if this will break some github workflow like dokka. @C10udburst can you take a look at this.

@azwarbahar
Copy link

LGTM

@Luna712
Copy link
Contributor

Luna712 commented Sep 20, 2025

Have the things I mentioned in #1493 been tested to not happen (like the error unknown class with library documentation)? IIRC I tried something very similar to this initially but it led to some of those issues so changed it a bit. Just want to confirm though.

@jimlyas
Copy link
Author

jimlyas commented Sep 21, 2025

like the error unknown class with library documentation)

Hi @Luna712, It's not happening when I run the dokka task

11.39.59: Executing 'dokkaGeneratePublicationHtml --rerun-tasks'…

Executing tasks: [dokkaGeneratePublicationHtml] in project /./cloudstream

Reusing configuration cache.
> Task :library:checkKotlinGradlePluginConfigurationErrors SKIPPED
> Task :library:preBuild UP-TO-DATE
> Task :library:preDebugBuild UP-TO-DATE
> Task :library:preReleaseBuild UP-TO-DATE
> Task :library:generateDebugResValues
> Task :library:generateReleaseResValues
> Task :library:javaPreCompileDebug
> Task :library:javaPreCompileRelease
> Task :library:generateDebugResources
> Task :library:generateReleaseResources
> Task :library:generateBuildKonfig
> Task :library:packageDebugResources
> Task :library:packageReleaseResources
> Task :library:parseDebugLocalResources
> Task :library:parseReleaseLocalResources
> Task :library:generateReleaseRFile
> Task :library:generateDebugRFile
> Task :library:transformCommonMainDependenciesMetadata

> Task :library:compileReleaseKotlinAndroid
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/MainAPI.kt:430:12 'constructor(items: List<SearchResponse>, hasNext: Boolean = ...): SearchResponseList' is deprecated. Use newSearchResponseList method.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/extractors/YoutubeExtractor.kt:70:47 'val url: String?' is deprecated. Deprecated in Java.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/MyDramaList.kt:323:33 Unchecked cast of 'kotlin.Any?' to 'kotlin.collections.Map<kotlin.String, kotlin.String>'.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/TmdbProvider.kt:145:30 'var rating: Int?' is deprecated. `rating` is the old scoring system, use score instead.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/TraktProvider.kt:242:34 'var rating: Int?' is deprecated. `rating` is the old scoring system, use score instead.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/utils/HlsPlaylistParser.kt:1028:20 'val APPLICATION_RAWCC: String' is deprecated. RawCC is a Google-internal subtitle format that isn't supported by this version of
        Media3. There is no replacement for this value.

> Task :library:compileReleaseJavaWithJavac NO-SOURCE

> Task :library:compileDebugKotlinAndroid
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/MainAPI.kt:430:12 'constructor(items: List<SearchResponse>, hasNext: Boolean = ...): SearchResponseList' is deprecated. Use newSearchResponseList method.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/extractors/YoutubeExtractor.kt:70:47 'val url: String?' is deprecated. Deprecated in Java.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/MyDramaList.kt:323:33 Unchecked cast of 'kotlin.Any?' to 'kotlin.collections.Map<kotlin.String, kotlin.String>'.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/TmdbProvider.kt:145:30 'var rating: Int?' is deprecated. `rating` is the old scoring system, use score instead.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/metaproviders/TraktProvider.kt:242:34 'var rating: Int?' is deprecated. `rating` is the old scoring system, use score instead.
w: file://./cloudstream/library/src/commonMain/kotlin/com/lagradost/cloudstream3/utils/HlsPlaylistParser.kt:1028:20 'val APPLICATION_RAWCC: String' is deprecated. RawCC is a Google-internal subtitle format that isn't supported by this version of
        Media3. There is no replacement for this value.

> Task :library:compileDebugJavaWithJavac NO-SOURCE
> Task :library:processDebugJavaRes
> Task :library:processReleaseJavaRes
> Task :library:bundleLibCompileToJarRelease
> Task :library:bundleLibRuntimeToJarRelease
> Task :library:bundleLibCompileToJarDebug
> Task :library:bundleLibRuntimeToJarDebug
> Task :library:createFullJarDebug
> Task :library:createFullJarRelease
> Task :library:dokkaGenerateModuleHtml
> Task :library:dokkaGeneratePublicationHtml
> Task :app:dokkaGenerateModuleHtml
> Task :app:dokkaGeneratePublicationHtml

> Task :library:logLinkDokkaGeneratePublicationHtml
Generated Dokka HTML publication: http://localhost:63342/CloudStream/library/build/dokka/html/index.html

> Task :app:logLinkDokkaGeneratePublicationHtml
Generated Dokka HTML publication: http://localhost:63342/CloudStream/app/build/dokka/html/index.html

> Task :dokkaGeneratePublicationHtml

> Task :logLinkDokkaGeneratePublicationHtml
Generated Dokka HTML publication: http://localhost:63342/CloudStream/build/dokka/html/index.html

BUILD SUCCESSFUL in 2m 22s
32 actionable tasks: 32 executed
Configuration cache entry reused.

Build Analyzer results available
11.42.22: Execution finished 'dokkaGeneratePublicationHtml --rerun-tasks'.

And the source link work as intended

source.link.mp4

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.

4 participants