Add Kotlindoc-only publishing and enable for Dataconnect #7330
Conversation
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @emilypgoogle, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new configuration option for Firebase libraries, allowing them to specify that only Kotlin documentation should be published. This change streamlines the documentation process by preventing the generation of Java documentation artifacts by Dackka when not needed. The new setting has been applied to the Dataconnect library as an initial implementation.
Highlights
- New Configuration Option: Introduced "onlyPublishKotlindoc" property in FirebaseLibraryExtension to control documentation publishing behavior, allowing libraries to specify that only Kotlin documentation should be generated.
- Dataconnect Integration: Enabled the new "onlyPublishKotlindoc" setting for the firebase-dataconnect library, ensuring it publishes only Kotlin documentation and avoids Java documentation artifacts.
- Dackka Generation Logic Update: Modified the Dackka documentation generation task to respect the "onlyPublishKotlindoc" flag, preventing the creation of the "android" folder (Java documentation) when this setting is true.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new onlyPublishKotlindoc flag for Firebase libraries, allowing them to generate only Kotlindoc documentation and skip Javadoc. The changes are well-implemented across the Gradle plugins. My review includes a couple of suggestions to improve code clarity and adhere to Kotlin best practices. One suggestion is to refactor a variable assignment to be more idiomatic and immutable. The other is to enhance the documentation for the new flag to clarify its dependency on the existing publishJavadoc flag.
plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt
Outdated
Show resolved
Hide resolved
plugins/src/main/java/com/google/firebase/gradle/plugins/FirebaseLibraryExtension.kt
Show resolved
Hide resolved
plugins test results67 tests 67 ✅ 1m 20s ⏱️ Results for commit e845dac. ♻️ This comment has been updated with latest results. |
Size Report 1Affected ProductsNo changes between base commit (ca9ec52) and merge commit (0ea5911).Test Logs |
Coverage Report 1Affected Products
Test Logs |
plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Outdated
Show resolved
Hide resolved
plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Outdated
Show resolved
Hide resolved
plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt
Outdated
Show resolved
Hide resolved
plugins/src/main/java/com/google/firebase/gradle/plugins/FirebaseLibraryExtension.kt
Show resolved
Hide resolved
Adds a new field for firebase libraries to enable kotlindoc-only publishing if they publish docs. This has been enabled for Dataconnect as well. When this is enabled, no
androidfolder is generated by Dackka.