Add a new plugin for Dackka #4023
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
This causes no issues on our part, and makes for an easy fix as far as grabbing the fat jar of dackka.
All `ComponentRegistrar` subclasses should be annotated with `@suppress` or `@hide`.
Created a bug to track Timestamp being incorrectly under `firebase-firestore` instead of `firebase-common`.
Dangling empty annotations were left in FirebaseInAppMessaging. This causes issues with certain javadoc systems.
Wrapped the pretex in a paragraph block, as dangling text causes issues with javadoc processing. b/243064949
Wrapped the pretex in a paragraph block, as dangling text causes issues with javadoc processing. b/243064949
In preparation of dackka implementation, these util methods will help keep certain segments easier to read.
Added a new plugin to replace our current dokka setup with dackka. This also includes various tasks to support the plugin.
I removed this for macOS testing, and accidentally committed the change.
Size Report 1Affected Products
Test Logs
Notes |
Coverage Report 1Affected Products
Test Logs
Notes |
vkryachko
reviewed
Aug 24, 2022
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/ProjectUtils.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Outdated
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Outdated
Show resolved
Hide resolved
Instead of ran, use the present-tense of run. Co-authored-by: Vladimir Kryachko <vkryachko@google.com>
b/243675474
I didn't mean to add it again.
b/243674303
b/243674305
Not really sure why this was here to begin with.
The firesite transform task will now directly pull the output dir from the generate documentation task. This allows us to avoid hardcoding strings, and any weird edge cases that could end up happening as a result.
Similar to the firesite task, this avoids as many hardcoded strings as possible.
Instead of passing around the task explicitly, just pass what the task needs. This is easier to maintain, read, and will be easier to integrate with other tasks.
Falls inline with other tasks.
go/todont
vkryachko
reviewed
Aug 24, 2022
go/todont
go/todont
Instead of having a separate extension method for it, just use the already fetched `LibraryExtension`.
Hopefully this fixes the failing buildSrc tests.
|
/retest |
1 similar comment
|
/retest |
|
@daymxn: The following test failed, say
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Our current Dokka implementation is old and was due for an upgrade. Thankfully, the folks over at AndroidX have been working on new tooling that integrates directly with Dokka- and provides translations for DevSite. This PR does not include the removal of any old systems, only the addition of the new ones. The java variant of our ref doc generations will remain the same until we are comfortable with the DackkaPlugin.
This PR comes with:
DackkaGenerationTaskfor creating ref docs with dackkaFiresiteTransformTaskfor translating Devsite output from dackka to Firesite ready outputDackkaPluginfor managing everything dackka related, and providing default configurationsAll functionality provided in this PR is annotated, and follows standard practices with newer Gradle versions. There are minor differences that we can not implement until we upgrade our AGP version (per #3974), but I've left comments around them to revisit in the future.