Refactor: Create core:api module and set up publishing#4362
Merged
Conversation
This commit refactors the project to establish a stable API for third-party integrations. Key changes: - A new `core:api` module is created, containing the `IMeshService.aidl` interface, which was moved from the `core:service` module. - The `core:model` and `core:proto` modules are now published as libraries alongside `core:api`. - A GitHub Actions workflow (`publish-packages.yml`) is added to automate publishing these libraries to GitHub Packages on release. - The `mesh_service_example` app is updated to consume these newly published artifacts instead of depending on the local modules directly. - Utility functions and UI-related extensions have been moved from `core:model` to new, more appropriate locations in `core:model:util` and `core:ui:util` to improve separation of concerns. - Documentation (`README.md`) has been added to explain how to use the new API.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4362 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 3 3
Lines 28 28
Branches 8 8
=====================================
Misses 28 28 ☔ View full report in Codecov by Sentry. |
The integration instructions in the README files for the root, `core/api`, and `core/model` modules have been updated. The previous instructions, which used a mix of Maven Central and GitHub Packages, are now replaced with a simpler, unified approach using JitPack. This change standardizes how third-party applications consume the API, model, and proto libraries.
This commit updates the `mesh_service_example`'s `build.gradle.kts` to use direct project dependencies (`projects.core.api`, `projects.core.model`, `projects.core.proto`) instead of versioned artifacts from a properties file. This change simplifies the build process by ensuring the example app is always built against the current source code of the core modules, removing the need to publish and resolve artifact versions during local development. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
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
1 participant
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 refactors the project to establish a stable API for third-party integrations.
Key changes:
core:apimodule is created, containing theIMeshService.aidlinterface, which was moved from thecore:servicemodule.core:modelandcore:protomodules are now published as libraries alongsidecore:api.publish-packages.yml) is added to automate publishing these libraries to GitHub Packages on release.mesh_service_exampleapp is updated to consume these newly published artifacts instead of depending on the local modules directly.core:modelto new, more appropriate locations incore:model:utilandcore:ui:utilto improve separation of concerns.README.md) has been added to explain how to use the new API.