-
Notifications
You must be signed in to change notification settings - Fork 236
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: separate boot and connector modules and normalize module and package structure #4065
chore: separate boot and connector modules and normalize module and package structure #4065
Conversation
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #4065 +/- ##
==========================================
+ Coverage 71.74% 74.54% +2.80%
==========================================
Files 919 976 +57
Lines 18457 19988 +1531
Branches 1037 1122 +85
==========================================
+ Hits 13242 14901 +1659
+ Misses 4756 4602 -154
- Partials 459 485 +26 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went through it line-by-line, and all seems good.
What this PR changes/adds
This PR separates the boot runtime modules from connector modules. It also normalizes the module and package naming scheme to make it consistent across the codebase. The following rules are applied:
Naming Conventions
Modules names adopt the following conventions:
-spi
suffix-lib
suffixcontrol-plane-
prefix (decided on a case-by-case basis)data-pane-
prefix (decided on a case-by-case basis)All package names begin with
org.eclipse.edc
and follow the module name:auth-basic
becomesorg.eclipse.edc.auth.basic
connector.controlplane
to the package:control-plane-catalog
becomesorg.eclipse.edc.connector.controlplane.catalog
connector.dataplane
to the package:data-plane-http
becomesorg.eclipse.edc.connector.dataplane.http
core
in the package name or notboot-spi
does not includeboot
in the package name (this is for historical reasons)Layout Conventions
/spi
Extension points and shared interfaces
/spi/common
Extension points used by various runtimes.
/core
Required extensions and libraries for various runtimes. These extensions implement basic functionality and are not designed to be substituted.
core
in package name/core/common
Required extensions and libraries used across multiple runtimes. All common modules begin with
org.edc
./core/control-plane
Required extensions and libraries for control plane runtimes.
org.edc.connector.controlplane
/core/data-plane
Required extensions and libraries for data plane runtimes.
org.edc.connector.dataplane
/extensions
Optional extensions and libraries for various runtimes
/common/extensions
Optional extensions and libraries used across multiple runtimes
/extensions/control-plane
Optional extensions and libraries used in control plane runtime
/extensions/data-plane/
Optional extensions and libraries used in data plane runtimes
Linked Issue(s)
Relates to #4028