feat(EM-30): Define Microservices Repository Structure and Naming Conventions#42
Open
devin-ai-integration[bot] wants to merge 1 commit intofeat/microservices-migration-v2from
Conversation
…ventions - Add services/ directory with 4 bounded context services (order, consumer, restaurant, courier) - Add libs/ directory with shared library scaffolding (common, common-jpa, domain, swagger, test-util) - Add infrastructure/ directory (docker, kubernetes overlays, environment configs) - Add _template-service archetype for scaffolding new services - Add ADR-0001 documenting repo strategy, package naming, and module conventions - Package convention: com.ftgo.<service>.<layer> (domain, service, web, config, messaging) - Module convention: :services:<name> for services, :libs:<name> for shared libs - Each service includes build.gradle, Dockerfile, K8s manifests, application.yml - Docker Compose uses environment variable references for all credentials - Existing monolith modules remain untouched at root level Co-Authored-By: Alex Baker <alexandercommander453@gmail.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
feat(EM-30): Define Microservices Repository Structure and Naming Conventions
Summary
Adds the foundational directory structure for the microservices migration alongside the existing monolith, with no modifications to existing files. This is the first task in the migration and establishes conventions for all subsequent work.
Key deliverables:
services/— Scaffolded directories for all 4 bounded contexts (order, consumer, restaurant, courier), each withbuild.gradle,Dockerfile, K8s manifests,application.yml, andREADME.mdlibs/— Shared library scaffolding (ftgo-common, ftgo-common-jpa, ftgo-domain, ftgo-common-swagger, ftgo-test-util) withbuild.gradlefilesinfrastructure/— Docker Compose for local dev, Kubernetes base/overlay structure (dev/staging/prod), environment config dirsservices/_template-service/— Archetype with__PLACEHOLDER__tokens for scaffolding new servicesdocs/adr/0001-microservices-repo-structure.md— ADR documenting mono-repo strategy, package naming (com.ftgo.<service>.<layer>), Gradle module naming (:services:*,:libs:*), and port assignmentsNot included (intentionally): No changes to
settings.gradle— the new modules are scaffolding only and are not yet wired into the Gradle build. This will happen in subsequent migration tasks.Review & Testing Checklist for Human
docs/adr/0001-microservices-repo-structure.mdcarefully. The biggest decision here is adoptingcom.ftgoas the new package root (replacingnet.chrisrichardson.ftgo). Confirm this is acceptable to the team before merging.git diff origin/feat/microservices-migration-v2 --name-statusand confirm all changes areA(added), notM(modified). The existing monolith should be completely untouched.build.gradlefiles useplugins { id 'org.springframework.boot' }without a version. When these are wired intosettings.gradle, verify the plugin resolves correctly from the rootbuildscriptclasspath (Gradle 4.10.2 behavior)._template-service/uses literal__PLACEHOLDER__directory names (e.g.,src/main/java/com/ftgo/__SERVICE_PACKAGE__/). Confirm this is the desired scaffolding mechanism vs. a script-based generator.Test Plan
Since this PR only adds scaffolding (no code changes, no
settings.gradlemodifications), there's nothing to build or run yet. The existing monolith build should be unaffected:./gradlew build # Should still fail on the pre-existing eventuate-util-test dependency issue, not due to this PRNotes
${DB_USERNAME}, etc.) — you'll need to set these when running locally. Consider adding a.env.examplein a follow-up.:latesttags — fine for scaffolding, but should be parameterized before production use.