cold-read 3회차(수정 세션 넷의 빈틈 9건), 통합·배치·문서 체계·번역 세션이 「매뉴얼에서 답을 못 찾았다」고 적은 곳, 프론트 총괄 교훈 둘, design-docs repo-structure 01·02·03의 「매뉴얼에 넣을 규칙」 중 백엔드 몫이 아직 매뉴얼에 없다. 세션마다 같은 판단을 스스로 다시 했다. 넣은 자리(항목별 표는 PR 본문): - delegate.md: upgrade 안내 「커밋:」 줄은 총괄이 합칠 때 적는다, 두 라운드 연속 결함이면 조사로, 병합 커밋에는 충돌 해결만, 자주 하는 실수 둘(충돌 없음은 merge-tree로, PR 만들기 전 head 브랜치의 PR을 API로). - improve.md: 절차 문서 결함과 대기 결함의 RED 모양, 테스트 Javadoc도 고친다, 그 코드를 지키는 lane 찾기, 두 라운드 연속 결함이면 조사로. - docs-writing.md: 문체·용어·언어 범위(코드 주석 제외), check-docs도 돌린다, 이동 커밋에 참조 수정을 같이, 번역 기준(영어 절 제목, 레지스트리 yaml, 머리말 없는 runbook, MANIFEST는 납품 당시 해시). - operate.md 4.1: zsh 파이프 rc와 자기 실행 멈추기, runner 사실(capacity 1, 12코어·31GB, 잠금 밖), 취약점 DB는 설치가 아니다, 형식은 나누기 전에. - reference/gates.md: 커밋하는 수정의 lockfile, 처음 켜진 lane의 이전 실패, lychee·buf·trivy 공식 이미지, smoke 이미지가 이 트리에서 만들어졌음, 원래 있던 실패 가리기(세 번), 순서 의존 재현, 공유 잠금 기다리기, 증거 실행의 --no-build-cache, 거짓 통과 두 줄(OOM 재시작, 조건 안 set -e), 새 7절 「workflow·검사 스크립트를 더할 때」. - reference/review-criteria.md: 관점 2·4·9·18·20·21·23·26·27의 볼 곳과 결함, Important 예시, leaf 변경 체크리스트(README 다섯 칸, 문서 검사). - reference/decisions.md: brief와 결정 원문이 다르면 원문, 취약점 DB 기본값. - reference/terms.md(새): 영어 그대로 쓰는 말과 「개발 환경」의 뜻. - README.md 2절(최상위 폴더는 큼), new-feature.md(테스트 환경·release/는 leaf 안), docs/ci-cd/template-vs-consumer.md(docs-check·link-check· check-repo-layout은 파생 서비스도 유지), settings-and-runtime 규칙. 버린 대안: 항목마다 따로 커밋(소유자 결정: 매뉴얼 보강은 한 묶음). 위험: 정한 기본값 둘은 소유자 확인 대상이다: 취약점 DB 받기 허용, 병합 커밋에 충돌 해결만. operate.md는 143/150줄, improve.md 144/150줄로 상한에 가깝다. 검증: check-work-docs(진입 경로 최대 269/350), check-docs, unittest 모두 rc=0.
3.0 KiB
3.0 KiB
Template maintainer와 Template consumer의 검증은 다르다
결론
이 저장소에는 성격이 다른 두 종류의 검증이 섞여 있다.
- 스켈레톤을 만드는 사람에게 필요한 검증 — optional 모듈 조합이 모두 빌드되는가, 레지스트리가 확장 가능한가.
- 스켈레톤을 가져다 서비스를 만드는 사람에게 필요한 검증 — 내 애플리케이션의 테스트, 아키텍처 방향, 보안, 릴리스.
파생 프로젝트가 1번을 그대로 물려받으면, 자기 서비스와 아무 상관 없는 게이트를 평생 유지하게 된다. 이 문서는 어느 쪽이 어느 쪽인지 적어 둔다.
Template 전용 (파생 프로젝트는 삭제해도 된다)
| 대상 | 무엇을 지키는가 |
|---|---|
docs/design/**, docs/history/** |
이 템플릿을 만든 과정의 설계서·계획서·납품 패키지·증거·학습 기록 |
gradle/qualification/** |
이 템플릿이 벤더링한 플랫폼(JPA, messaging)의 인증 체계 |
*-certification.yml, *-qualification.yml, jpa-next-*.yml |
템플릿이 광고하는 지원 매트릭스의 근거 |
Consumer 필수 (파생 프로젝트가 유지해야 한다)
| 대상 | 무엇을 지키는가 |
|---|---|
architectureCheck |
Clean Architecture 의존 방향. 이 템플릿의 존재 이유 |
각 leaf의 check |
컴파일 · 단위 테스트 · 포맷 · 스타일 · Error Prone |
qualityCheck |
SpotBugs / FindSecBugs |
configContractCheck |
환경변수 계약 |
verifyDependencyLocks |
재현 가능한 의존성 해석 |
dependency-vulnerability.yml |
dependency-review + Trivy |
ci-quality-gates.yml |
PR 게이트 |
release.yml |
이미지 · SBOM 생산 |
docs-check.yml |
문서 규칙(scripts/check-docs.py: 언어·머리 블록·참조·숫자·지도·링크·문체)과 Gradle 밖 스크립트·편집 훅의 시험(scripts/tests/). 파생 서비스의 문서도 같은 규칙을 따른다(docs/README.md) |
link-check.yml |
문서의 외부 URL과 상대 링크(lychee) |
scripts/check-repo-layout.py(ci-quality-gates.yml 안) |
저장소 최상위 배치. 서비스가 최상위 항목을 더하면 허용 목록과 AGENTS.md 지도를 함께 고친다 |
| action의 full SHA 핀 | 공급망 |
파생 프로젝트가 할 일
- Template 전용 표의 항목을 삭제한다. 삭제는 대부분 파일 삭제 +
config/architecture/modules.json에서 leaf 항목 제거로 끝난다 — 레지스트리가 leaf 목록의 SSOT이고, 개수를 따로 적어 둔 곳은 없다. docs/ci-cd/boundary.md의 경계를 그대로 유지한 채 자기 GitOps 저장소를 연결한다..trivyignore.yaml과 CODEOWNERS는 그대로 쓴다.
아직 하지 않은 것
Template CI와 Generated Application CI를 물리적으로 분리하지는 않았다(생성기 없음). 지금은 이 문서가 그 경계다. 생성기를 만든다면, 위 표의 "Template 전용" 열이 생성기가 벗겨 내야 할 목록이다.