dataconnect: demo: Setup dokka #7033
Conversation
…Connect emulator executable to use.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as off-topic.
This comment was marked as off-topic.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
dconeybe
changed the base branch from
main
to
dconeybe/dataconnect/DemoEmulatorExecutableProperty
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Summary of ChangesThis pull request integrates the Dokka documentation engine into the Data Connect demo project. This addition allows for the generation of KDoc documentation from the Kotlin source code, including sources generated by Data Connect, making the demo code easier to understand and navigate through generated documentation. Highlights
Changelog
Activity
|
There was a problem hiding this comment.
Pull Request Overview
Adds Dokka documentation generation to the Data Connect demo by applying the Dokka plugin, configuring it to include generated sources, and updating CI to produce and upload HTML docs.
- Apply and configure
org.jetbrains.dokkaplugin in the demo module - Enable Dokka V2 experimental plugin mode via
gradle.properties - Add CI steps to run Dokka and upload generated HTML documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| firebase-dataconnect/demo/gradle.properties | Enable Dokka V2 plugin mode and suppress warnings |
| firebase-dataconnect/demo/build.gradle.kts | Add Dokka plugin (v2.0.0) and configure source roots |
| .github/workflows/dataconnect_demo_app.yml | Run Dokka in CI and upload HTML output as an artifact |
Comments suppressed due to low confidence (3)
.github/workflows/dataconnect_demo_app.yml:120
- The Gradle task 'dokkaGeneratePublicationHtml' may not exist in Dokka 2.0; you might need to use the built-in 'dokkaHtml' task or confirm the exact task name to prevent CI failures.
dokkaGeneratePublicationHtml
.github/workflows/dataconnect_demo_app.yml:139
- The upload path 'build/dokka/html' might not match Dokka’s actual output directory (often includes the module name); consider using a wildcard (e.g., 'build/dokka/html/**') or verify the folder structure to ensure the artifacts are captured.
path: firebase-dataconnect/demo/build/dokka/html
firebase-dataconnect/demo/gradle.properties:9
- [nitpick] Adding a brief comment to explain these experimental flags (enabling Dokka V2 mode and suppressing warnings) would help future maintainers understand their purpose.
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
Test Results 1 077 files + 38 1 077 suites +38 36m 26s ⏱️ +54s For more details on these failures, see this check. Results for commit 05485ff. ± Comparison against base commit 11dfdac. ♻️ This comment has been updated with latest results. |
…stead of just `dataConnectEmulatorExecutable`
…to dconeybe/dataconnect/DemoDokka2
Size Report 1Affected ProductsNo changes between base commit (11dfdac) and merge commit (63a044b).Test Logs |
Coverage Report 1Affected Products
Test Logs |
dconeybe
changed the title
Integrate the Dokka documentation engine into the Data Connect demo project. This addition allows for the generation of KDoc documentation from the Kotlin source code, including sources generated by Data Connect. This will be especially useful for testing the README.md that gets generated as part of the codegen, which is not yet released (Googlers see cl/769257895).
Highlights
org.jetbrains.dokkaGradle plugin to thefirebase-dataconnect/demomodule's build file.dataConnect/generatedSourcesdirectory.gradle.propertiesto enable Dokka's V2 plugin mode.