Files
clean-architecture-backend-…/docs/work/reference/related-repos.md
T
DongHyeonka 7dc5725fe7 docs!: 메시징 문서를 messaging-library로 보내고 관련 저장소 절을 채운다
앞 커밋이 메시징 플랫폼을 지웠지만 살아 있는 문서는 아직 src/platforms
경로와 docs/messaging/을 부른다. 기록 8개의 머리 블록 「현재 정본」도
지운 docs/messaging/support-matrix.md를 가리킨다.

- docs/messaging/(10개)을 지운다. 같은 이름의 파일이 이력째
  messaging-library에 있다. 이 repo에서 그 내용을 부르던 문서(manual 09,
  messaging-kafka README·AGENTS)는 그 repo 파일로 링크한다.
- 기록(설계서 3, 계획서 3, 납품 패키지 2): 본문은 두고 머리 블록만
  고쳤다. 플랫폼을 다룬 것은 「없음 — messaging-library로 옮겼다」, 앱
  쪽 발행·소비를 다룬 것은 docs/manual/09-outbox-events.md.
- docs/work/reference/related-repos.md: 관련 저장소 표(메시징 줄 채움),
  라이브러리를 고치는 법, 템플릿에서 버전 올리는 법, 같이 고칠 때
  composite build(Gradle 루트가 src/라 ../../messaging-library), registry
  라이브러리 칸. 설계 14절이 근거다.
- src/config/architecture/README.md: library_groups·allowed_libraries 설명.
- docs/upgrade/2026-11-maturity-review.md 3.9절: B-57(지운 것), B-58(받는
  법·패키지·auto-config 이름), B-59(registry 칸).
- 진입 문서와 지역 지침(AGENTS.md, README.md, delegate, decisions,
  review-criteria, defect-patterns, gates, capability-status, manual 07,
  build-logic·persistence-jpa·inbound messaging·shared-contract 지침,
  env-keys 주석)에서 「들여온 제품」·src/platforms 문장을 별도 repo
  라이브러리 문장으로 바꿨다.

위험: 다른 repo 파일을 가리키는 링크는 lychee가 외부 URL로 본다(공개
repo라 익명으로 읽힌다).

검증: python3 scripts/check-docs.py OK, check-work-docs.py OK(상대 링크
깨짐 0), check-repo-layout.py OK, python3 -m unittest discover -s
scripts/tests OK.

BREAKING CHANGE: docs/messaging/이 없어졌다. 메시징 문서는
messaging-library repo의 docs/messaging/에 있다.

Refs: design-docs repo-structure/05-library-repos.md 4.3·14절
2026-11-08 17:11:33 +09:00

5.7 KiB

관련 저장소 — 템플릿 밖에서 관리하는 라이브러리

프로젝트 계층이 아닌 라이브러리는 이 repo에 두지 않는다(소유자 결정 2026-11-07, decisions.md 「라이브러리 repo」). 라이브러리마다 별도 repo에서 고치고 Gitea Packages에 버전으로 배포한다. 이 문서는 그 목록과, 템플릿에서 그 라이브러리를 다루는 법이다. 설계 근거는 design-docs repo-structure/05-library-repos.md다.

1. 목록

repo 무엇 Maven group 카탈로그 칸 쓰는 leaf
messaging-library 메시징 제품(발행·소비 API, Kafka transport, outbox·inbox, 인증 증거) dev.cakit.messaging messagingLibrary adapter:outbound:messaging(core-api), adapter:outbound:messaging-kafka(starter-kafka, runtimeOnly), adapter:inbound:messaging(core-api, reliability, reliability-api, reliability-jdbc-postgresql). 시험만: composition:outbox-relay(starter, testCompileOnly), adapter:outbound:persistence-jpa(reliability-jdbc-postgresql jar의 migration)
grpc-library gRPC 플랫폼(Stable 7, advanced 2) dev.cakit.grpc 없음(채택 전) 없음. adapter:inbound:grpc는 io.grpc를 직접 쓴다. 채택은 별도 결정이다
  • 고치는 법·게이트·릴리스는 각 repo의 docs/work/다. 이 repo의 매뉴얼은 위치만 가리킨다.
  • 템플릿은 src/settings.gradle의 exclusiveContent 저장소 하나로 받는다: dev.cakit group과 그 아래는 소유자 Gitea Packages에서만, 나머지는 Maven Central에서만 찾는다. 공개 owner라 읽기 토큰은 필요 없다. 이미지 빌드(src/Dockerfile의 verifyDependencyLocks)도 토큰 없이 Gitea에 닿아야 한다.
  • 라이브러리 패키지(dev.cakit.*)는 템플릿 재사용 체크리스트의 「dev.caskeleton을 새 패키지로 바꾼다」에 들지 않는다.

2. 라이브러리를 고칠 때

  • 템플릿 안에서 라이브러리 코드를 고치지 않는다. 라이브러리 repo에서 고치고 릴리스한다.

  • 템플릿 변경 때문에 라이브러리를 고쳐야 하면 두 repo에 브랜치를 하나씩 만들고, 두 repo를 같은 부모 폴더에 둔다(desktop은 ~/workspace/). 템플릿에서 명령 줄로만 라이브러리를 끼워 같이 시험한다(composite build: Gradle이 같은 group:artifact의 외부 의존성을 끼운 빌드의 프로젝트로 바꿔 끼운다). Gradle 루트가 src/라 경로는 두 단계 위다.

    ./gradlew --include-build ../../messaging-library <태스크>
    

    그 상태로 lockfile을 쓰거나 커밋하지 않는다. 끼운 모듈은 lockfile 밖으로 빠질 수 있다. 끼운 빌드는 자기 카탈로그로 컴파일되므로 라이브러리 repo CI 결과와 다를 수 있다. 최종 판정은 배포한 좌표로 돈 템플릿 게이트다.

  • 병합 순서는 하나다: 라이브러리 PR 병합 → 태그·릴리스 → 템플릿 PR에서 버전을 올리고 lockfile을 다시 쓴다 → 템플릿 병합. 끼운 상태로만 통과하는 템플릿 PR은 병합하지 않는다.

  • 라이브러리가 끌고 온 취약 의존성은 템플릿에서 먼저 덮어 막고(Boot 버전이나 카탈로그 pinned-*. 지금 pinned-lz4-java·pinned-snappy-java는 메시징 라이브러리의 kafka-clients가 끌고 오는 것을 막는다), 라이브러리 repo에 수정을 남긴다.

3. 템플릿이 라이브러리 버전을 올릴 때

  1. src/gradle/libs.versions.toml의 라이브러리 버전 칸(messagingLibrary)을 바꾼다. 같은 라이브러리의 모듈은 그 칸 하나로 같이 오른다.
  2. desktop에서 ./gradlew resolveAndLockAll --write-locks 뒤 verifyDependencyLocks. lockfile 차이는 그 라이브러리 줄과 그것이 끌고 오는 외부 의존성뿐이어야 한다.
  3. 쓰는 leaf의 check와 architectureCheck, 그 leaf의 lane(메시징: :adapter:inbound:messaging:messagingInboxRedeliveryIntegrationTest, :adapter:outbound:messaging-kafka:messagingKafkaRelayIntegrationTest, persistence-jpa test의 migration 시험).
  4. 라이브러리 CHANGELOG.md에서 그 사이 버전의 깨지는 변경을 읽는다. MAJOR면 docs/upgrade/에 행을 더하고 커밋 제목에 !. migration을 더한 버전이면 src/adapter/outbound/persistence-jpa/src/test/resources/db/applied-migrations.sha256에 줄을 더한다.
  5. 커밋 제목 예: build(deps): 메시징 라이브러리를 1.1.0으로 올린다.

4. 경계 검사(registry)

라이브러리 모듈은 이 빌드의 프로젝트가 아니어서 allowed_dependencies가 보지 못한다. 그래서 registry가 두 칸을 더 가진다(src/config/architecture/README.md 「별도 repo 라이브러리」).

  • 맨 위 library_groups(["dev.cakit"]): 다스릴 group 접두사.
  • 행마다 allowed_libraries: 그 leaf가 쓸 수 있는 group:artifact. 운영 선언(runtimeOnly 포함)과 컴파일에서 보이는 소유 group 모듈이 모두 이 칸에 있어야 방향 검사가 통과한다.
  • 새 라이브러리 모듈을 leaf에 들일 때는 카탈로그 항목, leaf build.gradle, 그 행의 allowed_libraries를 같은 변경에서 바꾼다.

5. 처음 채택할 때(gRPC 같은 라이브러리)

src/settings.gradle의 저장소 선언은 이미 dev.cakit를 덮으니 바꾸지 않는다. 카탈로그에 버전 칸 하나와 쓰는 모듈의 [libraries] 항목을 더하고(version.ref로 그 칸을 쓴다), 쓰는 leaf의 registry 행에 allowed_libraries를 적고, lockfile을 다시 쓴다. 1절 표에 카탈로그 칸과 쓰는 leaf를 적는다.