Files
clean-architecture-backend-…/docs/upgrade/2026-11-relayout.md
T
DongHyeonka 6a792b8144 refactor(layout)!: 옮긴 경로를 부르는 곳을 모두 새 배치에 맞춘다
문제: 앞 커밋이 Gradle 루트를 저장소 루트로 옮기고 계층 폴더를 묶었다.
빌드 스크립트·build-logic·시험·workflow·스크립트·문서가 아직 옛 배치
(Gradle 루트 = src/)를 가정해 빌드가 되지 않는다.

고른 방법:
- Gradle 경로와 registry id는 그대로 둔다(:app-bootstrap, :application-core,
  :composition:*). registry의 source_path만 새 폴더를 가리킨다. 폴더에 맞춘
  이름(:domain:core, :application:core)은 프로젝트 이름 core가 둘이 되어
  boot jar의 BOOT-INF/lib와 기본 capability가 겹치고, 파생 서비스의 모든
  project(':…') 줄을 바꾸게 한다.
- registry는 gradle/modules.json, 시험 이미지 목록은
  gradle/container-images.properties: 버전 카탈로그 옆, 빌드가 고정하는 것.
  config/는 코드 검사 도구 설정만 둔다.
- build-logic: settings·architecture 플러그인의 저장소 루트를 Gradle 루트로
  (getParentFile 제거). config contract의 파일 트리는 src/만 훑는다(루트를
  훑으면 docs·.claude/worktrees까지 줍는다).
- 빌드 스크립트: rootProject.projectDir.parentFile → rootProject.projectDir,
  rootProject.file('../…') → rootProject.file('…'), 옛 src 기준 include에
  src/를 붙인다. notification API surface의 application-notification 소스
  루트를 새 폴더로(놓치면 272개 타입이 surface에서 말없이 빠진다).
- 시험: 옛 src 기준 모듈 목록과 ../ 개수를 고친다. 없는 폴더를 말없이
  건너뛰던 목록(MessagingAuthority, NotificationPayloadAtRest 등)을 새
  폴더로, FileserverDocumentationCoverageTest는 Gradle 경로 → 폴더를
  registry로 찾는다. Docker 계약은 WORKDIR /build, 새 jar 경로.
- Docker: 빌드 context를 저장소 루트로, .dockerignore는 허용 목록으로 다시
  써서 전에 context였던 것만 들어가게 한다. compose의 build.context는 .,
  env_file은 ./.env.
- workflow: working-directory: src 기본값과 그것을 되돌리던 줄을 지운다.
- scripts: verify.sh, ci/*, bootstrap-local, new-feature,
  verify-feature-scaffold, mongo 검증, hooks, check-repo-layout 허용 목록.
  check-docs의 경로 검사는 build-logic/·gradle/로 시작하는 경로도 본다.
- 문서: AGENTS.md 지도, README 구조 표, leaf AGENTS.md의 cd src, gates·
  operate·결정 색인, src/bootstrap/AGENTS.md를 조립 계층 family 규칙으로
  다시 쓴다. 기록 문서(docs/design·history·reviews, 지난 upgrade 안내,
  capability-status 제거 표)는 머리 블록만 고친다. 파생 서비스용 안내
  docs/upgrade/2026-11-relayout.md를 더한다.

위험: bootRun working dir가 저장소 루트가 되어 .env와 상대 경로 설정이
루트 기준이다. 루트 .env는 compose 보간에도 읽힌다(upgrade 안내 5절).
파생 서비스는 태그 pre-relayout-2026-11까지 받은 뒤 이 묶음을 받는다.

검증: desktop에서 캐시 없이 scripts/verify.sh docs·pr·main·release,
compose smoke 18 lane, 빠른 시작(scripts/verify.sh app). 결과는 PR 본문.
구조 리뷰(arch-reviewer) 지적 5건을 반영했다.

BREAKING CHANGE: Gradle은 저장소 루트에서 돈다(cd src 없음). registry는
gradle/modules.json, 이미지 빌드 context는 저장소 루트다. 옛 경로 → 새 경로
표는 docs/upgrade/2026-11-relayout.md.
Refs: design-docs repo-structure/01-backend-layout.md 6.1절 가-2·가-3
2026-11-11 22:15:42 +09:00

8.2 KiB

업그레이드 안내 — 2026-11 저장소 재배치(Gradle 루트를 저장소 루트로)

  • 범위: Gradle 루트를 src/에서 저장소 루트로 옮기고, src/에 계층 코드만 남긴 변경. 코드·패키지·Gradle 경로·registry id는 바뀌지 않았고 파일 위치만 바뀌었다.
  • 근거: design-docs repo-structure/01-backend-layout.md 6.1절 가-2·가-3, repo-structure/05-library-repos.md 「Gradle 루트 옮기기는 라이브러리 분리 다음에」, docs/work/reference/decisions.md 「Gradle 루트 위치」
  • 재배치 직전 커밋: 태그 pre-relayout-2026-11

1. 누가 읽나

이 템플릿을 upstream remote로 두고 merge해 받는 파생 서비스가 읽는다. 거의 모든 빌드 파일과 계층 폴더의 경로가 바뀌므로, 밀린 템플릿 변경과 이 재배치를 한 번에 받으면 충돌의 원인을 가르기 어렵다. 그래서 두 번에 나눠 받는다.

2. 받는 순서

차례 받는 것 할 일 확인
A 태그 pre-relayout-2026-11까지 git fetch upstream --tags 후 git merge pre-relayout-2026-11. 충돌은 그 사이의 다른 안내(docs/upgrade/의 다른 파일)대로 푼다. 이 차례에서는 경로가 하나도 바뀌지 않는다 옛 배치 그대로 cd src && ./gradlew ci
B 재배치(태그 다음 커밋부터 upstream main) 4절대로 merge하고 5절의 서비스 쪽 경로를 고친다 6절

A를 끝내고 초록인 상태에서 B를 시작한다. B의 충돌은 모두 「서비스가 고친 파일이 옮겨졌다」 하나의 원인이다.

3. 옮긴 경로

src/ 아래에서 옮기지 않은 것: src/adapter/**, src/shared-contract/.

옛 경로 새 경로
src/settings.gradle, src/build.gradle, src/gradle.properties settings.gradle, build.gradle, gradle.properties
src/gradlew, src/gradlew.bat, src/settings-gradle.lockfile gradlew, gradlew.bat, settings-gradle.lockfile
src/gradle/ (wrapper, libs.versions.toml) gradle/
src/build-logic/ build-logic/
src/config/checkstyle/, src/config/spotbugs/ config/checkstyle/, config/spotbugs/
src/config/architecture/modules.json (registry) gradle/modules.json
src/config/architecture/README.md gradle/README.md (폴더 안내를 앞에 더했다)
src/config/testing/container-images.properties gradle/container-images.properties
src/Dockerfile, src/.dockerignore Dockerfile, .dockerignore (빌드 context가 저장소 루트)
src/.env.example, src/.env.local.example (로컬 src/.env) .env.example, .env.local.example (로컬 .env)
src/README.md (빌드·env 참조) docs/build.md
src/.gitignore 루트 .gitignore에 합쳤다
src/domain-core/ src/domain/core/
src/application-core/ src/application/core/
src/application-fileserver/, src/application-notification/, src/application-objectstorage/ src/application/fileserver/, src/application/notification/, src/application/objectstorage/
src/app-bootstrap/ src/bootstrap/app/
src/composition/<leaf>/ (여섯) src/bootstrap/<leaf>/
src/composition/AGENTS.md src/bootstrap/AGENTS.md (조립 계층 family 규칙으로 다시 썼다)

바뀌지 않은 것:

  • Gradle 경로와 registry id: :domain-core, :application-core, :app-bootstrap, :composition:outbox-relay 등. 서비스 build 파일의 project(':…') 줄은 그대로 둔다. 폴더는 registry의 source_path가 정한다.
  • Java 패키지, jar 이름(app-bootstrap-<버전>.jar), 이미지 안의 경로(/app).
  • workflow 이름과 단계 태스크(prCheck·mainCheck·releaseCheck). workflow에는 working-directory: src가 없어졌다.

4. B 차례 merge

  1. 작업 브랜치를 따로 만든다. 로컬 src/.env가 있으면 .env로 옮긴다(추적하지 않는 파일이라 merge가 옮기지 않는다). 빌드 출력(src/**/build/, src/.gradle/)은 지운다. 옛 위치에 남아 IDE와 Gradle을 헷갈리게 한다.

  2. 이름 바꾸기 감지 한도를 올려 merge한다. 재배치는 파일 1,517개를 옮겼고 git의 기본 한도를 넘을 수 있다.

    git -c merge.renameLimit=20000 -c diff.renameLimit=20000 merge upstream/main
    
  3. 템플릿은 「옮기기만」 커밋과 「경로 고치기」 커밋을 나눠 두었다. 충돌이 많으면 먼저 옮기기 커밋까지 merge하고 (git log --oneline pre-relayout-2026-11..upstream/main의 refactor(layout)!: 커밋), 그다음 나머지를 받는다. 첫 merge에서는 서비스가 고친 파일이 새 자리로 따라가는지만 본다.

  4. 「삭제 대 수정」 충돌은 대개 서비스가 고친 파일이 옮겨진 경우다. 새 자리(3절 표)의 파일에 서비스 쪽 변경을 옮긴다.

5. 서비스 쪽에서 고칠 것

  • 서비스가 더한 leaf: registry gradle/modules.json의 그 행 source_path를 새 배치에 맞추거나, 폴더를 그대로 두려면 scripts/check-repo-layout.py의 SRC_ALLOWED에 그 최상위 폴더를 더한다. src/ 바로 아래에는 계층 폴더 (domain, application, adapter, bootstrap, shared-contract)만 둔다. 서비스 기능의 application leaf는 src/application/<이름>/, 조립 leaf는 src/bootstrap/<이름>/이 같은 모양이다.
  • 서비스의 스크립트·CI·문서: cd src, working-directory: src, (cd src && ./gradlew …), src/gradlew를 지운다. Gradle은 저장소 루트에서 돈다. git grep -n -e 'cd src' -e 'working-directory: src' -e 'src/gradlew'로 찾는다.
  • 저장소 루트를 계산하는 빌드 스크립트: rootProject.projectDir.parentFile은 이제 저장소의 부모다. rootProject.projectDir로 바꾼다. rootProject.file('../docs/…')는 rootProject.file('docs/…')로 바꾼다.
  • 저장소 파일을 읽는 시험: src/config/architecture/modules.json을 찾던 루트 탐색은 gradle/modules.json을 찾는다. Gradle 루트(옛 src/) 기준 경로("app-bootstrap/…", "application-core/…")는 "bootstrap/app/…", "application/core/…"처럼 src/ 기준으로, 또는 저장소 루트 기준 src/…로 바꾼다. 모듈 폴더에서 ../../docs처럼 센 상대 경로는 옮긴 leaf에서 한 단계 깊어진다(src/bootstrap/app, src/application/*, src/domain/core).
  • Docker: 이미지 빌드 context가 저장소 루트다. docker build -f Dockerfile .. 서비스가 src/Dockerfile을 고쳤으면 WORKDIR /build와 /build/src/bootstrap/app/build/docker/… 경로를 새 파일에서 확인한다. 서비스가 이미지에 더 넣는 파일이 있으면 .dockerignore의 허용 목록(첫 묶음)에 더한다.
  • bootRun: working dir가 저장소 루트다(전에는 src/). .env를 루트에서 읽고, 상대 경로 설정(APP_LOG_FILE_PATH=logs/…)도 루트 기준이다. 루트 .gitignore가 /logs/를 무시한다.
  • compose: compose.yaml의 build.context는 ., env_file은 ./.env다. 로컬 .env가 compose 파일 옆에 오므로 Docker Compose가 그 파일을 보간(${…})에도 읽는다. 전에는 src/.env라 보간에 쓰이지 않았다. 그래서 .env에 적은 APP_DATASOURCE_USERNAME·APP_DATASOURCE_PASSWORD·APP_SERVER_PORT·APP_SERVER_SHUTDOWN_TIMEOUT이 db 서비스의 계정과 포트 매핑에도 들어간다(bootRun과 db가 같은 값을 쓴다). 다른 값을 쓰려면 그 키를 .env에서 빼거나 docker compose --env-file로 따로 준다. compose lane은 값을 생성한 overlay로 넣으므로 영향이 없다.
  • 문서 검사: scripts/check-docs.py의 경로 검사가 build-logic/·gradle/로 시작하는 인라인 경로도 본다.

6. 확인

python3 scripts/check-repo-layout.py
python3 scripts/check-docs.py
./gradlew architectureCheck :app-bootstrap:architectureTest --console=plain
./gradlew :prCheck --console=plain
./gradlew :verifyStrictLaneStages --dry-run --console=plain

scripts/verify.sh pr가 위 Gradle 줄을 desktop에서 한 번에 돈다. 이미지를 내보내는 서비스는 docker build -f Dockerfile . --build-arg RELEASE_VERSION=0.0.1 --build-arg GIT_SHA=local도 한 번 돌린다.