refactor(build): Centralize Dokka configuration into convention plugin#4173
Merged
Conversation
This commit refactors the Dokka documentation generation setup by centralizing its configuration into a new `DokkaConventionPlugin`. Key changes include: - Removing the fragmented Dokka configuration from the root `build.gradle.kts` file. - Creating a `DokkaConventionPlugin` to apply a standardized Dokka setup across all modules. - Applying the new convention plugin to Android application, Android library, and KMP library modules. - Removing outdated Dokka V2 properties from `gradle.properties`. - Updating dependency declarations for the Dokka plugin. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
This commit refactors the build logic by creating dedicated convention plugins for Kover (code coverage) and Dokka (documentation). Key changes: - Created `KoverConventionPlugin` to apply and configure Kover for each module. - Moved Dokka configuration logic from `DokkaConventionPlugin` into a reusable `configureDokka` function. - Removed duplicated Kover and Dokka plugin applications and configurations from individual module `build.gradle.kts` files. - Centralized Kover and Dokka aggregation logic in the `RootConventionPlugin`. - Updated Android and KMP convention plugins to apply the new `meshtastic.kover` and `meshtastic.dokka` plugins. - Updated copyright years across various build files. This centralization simplifies module build scripts, reduces redundancy, and makes the build configuration more maintainable. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4173 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 2 3 +1
Lines 19 23 +4
Branches 7 7
=====================================
- Misses 19 23 +4 ☔ View full report in Codecov by Sentry. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit refactors the Dokka documentation generation setup by centralizing its configuration into a new
DokkaConventionPlugin.Key changes include:
build.gradle.ktsfile.DokkaConventionPluginto apply a standardized Dokka setup across all modules.gradle.properties.