pr / done (pull_request) Successful in 12m17s
scripts/verify.sh docs와 docs/work/reference/gates.md는 docs 단계 (check-work-docs.py 포함)가 pr.yml의 prCheck 안에서 돈다고 적는다. 실제 prCheck는 check-docs.py·scripts/tests·check-repo-layout.py만 돌리고 check-work-docs.py는 빠져 있었다. 그래서 operate.md가 줄 상한을 넘은 PR(#12)이 PR 단계 초록으로 main에 들어갔다. check-repo-layout.py·check-docs.py와 같은 모양의 Exec 태스크 verifyWorkDocs를 만들어 prCheck에 붙였다. 검사 본문은 Gradle 밖 스크립트 그대로다(소유자 결정: 매뉴얼 검사 장치는 scripts/). 버린 안: pr.yml에 python step을 따로 두기 — 단계 job은 Gradle 한 줄 이라는 verifyStrictLaneStages 형식과 어긋나고, verify.sh pr와 workflow가 다른 것을 돌리게 된다. 위험: 파생 서비스도 같은 상한을 PR에서 지켜야 한다 (template-vs-consumer.md에 행을 더했다). 검사는 1초 안쪽이다. 검증: scripts/verify.sh docs(노트북) rc=0. desktop prCheck는 이 커밋 메시지 뒤 PR 실행과 desktop verify.sh pr로 본다.
54 lines
3.9 KiB
Markdown
54 lines
3.9 KiB
Markdown
# Template maintainer와 Template consumer의 검증은 다르다
|
|
|
|
## 결론
|
|
|
|
이 저장소에는 성격이 다른 두 종류의 검증이 섞여 있다.
|
|
|
|
1. **스켈레톤을 만드는 사람**에게 필요한 검증 — optional 모듈 조합이 모두 빌드되는가, 레지스트리가
|
|
확장 가능한가.
|
|
2. **스켈레톤을 가져다 서비스를 만드는 사람**에게 필요한 검증 — 내 애플리케이션의 테스트,
|
|
아키텍처 방향, 보안, 릴리스.
|
|
|
|
파생 프로젝트가 1번을 그대로 물려받으면, 자기 서비스와 아무 상관 없는 게이트를 평생 유지하게 된다.
|
|
이 문서는 어느 쪽이 어느 쪽인지 적어 둔다.
|
|
|
|
## Template 전용 (파생 프로젝트는 삭제해도 된다)
|
|
|
|
| 대상 | 무엇을 지키는가 |
|
|
| --- | --- |
|
|
| `docs/design/**`, `docs/history/**` | 이 템플릿을 만든 과정의 설계서·계획서·납품 패키지·증거·학습 기록 |
|
|
| `main.yml`의 nightly job(`jpa-postgresql`, `httpclient-transport`, `redis-topology`, `fileserver-nfs-ambiguity`, `notification-chaos`, `jpa-next`, `object-storage-aws`)과 `release.yml`의 영역별 release lane | 템플릿이 광고하는 지원 매트릭스의 근거. 서비스가 그 capability를 쓰면 남기고, 지운 capability의 job은 같이 지운다 |
|
|
|
|
## Consumer 필수 (파생 프로젝트가 유지해야 한다)
|
|
|
|
| 대상 | 무엇을 지키는가 |
|
|
| --- | --- |
|
|
| `architectureCheck` | Clean Architecture 의존 방향. 이 템플릿의 존재 이유 |
|
|
| 각 leaf의 `check` | 컴파일 · 단위 테스트 · 포맷 · 스타일 · Error Prone |
|
|
| `qualityCheck` | SpotBugs / FindSecBugs |
|
|
| `configContractCheck` | 환경변수 계약 |
|
|
| `verifyDependencyLocks` | 재현 가능한 의존성 해석 |
|
|
| `pr.yml`(`./gradlew :prCheck`, 필수 검사 `pr / done`) | PR 단계. 무엇을 돌리는지는 Gradle 태스크 `prCheck`가 정한다 |
|
|
| `main.yml`의 `main`(두 단계를 한 줄로)·`build-logic`·`configuration-cache` job | main 단계(`mainCheck`, `integrationCheck`) |
|
|
| `main.yml`의 `performance` job | nightly 성능 단계(`performanceCheck`) |
|
|
| `pr.yml` `done`의 Trivy step과 `main.yml`의 `vulnerabilities` job(`scripts/ci/trivy-scan.sh`) | Trivy와 CISA KEV |
|
|
| `release.yml` | `releaseCheck`, 이미지 · SBOM · 서명 |
|
|
| `scripts/verify.sh` | 사람·세션이 workflow와 같은 단계를 돌리는 진입점 |
|
|
| `prCheck`의 `verifyWorkDocs` | 작업 지침의 분량 상한·본문 이력 ID 0·playbook 뼈대(`scripts/check-work-docs.py`). 파생 서비스도 `docs/work/`와 `AGENTS.md`를 받으니 같은 상한을 지킨다 |
|
|
| `prCheck`의 `documentCheck`·`testDocumentChecks` | 문서 규칙(`scripts/check-docs.py`: 언어·머리 블록·참조·숫자·지도·링크·문체)과 Gradle 밖 스크립트·편집 훅의 시험(`scripts/tests/`). 파생 서비스의 문서도 같은 규칙을 따른다(`docs/README.md`) |
|
|
| `main.yml`의 `links` job | 문서의 외부 URL과 상대 링크(lychee) |
|
|
| `scripts/check-repo-layout.py`(`prCheck`의 `verifyRepositoryLayout`) | 저장소 최상위 배치. 서비스가 최상위 항목을 더하면 허용 목록과 `AGENTS.md` 지도를 함께 고친다 |
|
|
| action의 전체 URL·full SHA 핀 | 공급망 |
|
|
|
|
## 파생 프로젝트가 할 일
|
|
|
|
1. Template 전용 표의 항목을 삭제한다. 삭제는 대부분 파일 삭제 + `gradle/modules.json`
|
|
에서 leaf 항목 제거로 끝난다 — 레지스트리가 leaf 목록의 SSOT이고, 개수를 따로 적어 둔 곳은 없다.
|
|
2. `docs/ci-cd/boundary.md`의 경계를 그대로 유지한 채 자기 GitOps 저장소를 연결한다.
|
|
3. `.trivyignore.yaml`과 CODEOWNERS는 그대로 쓴다.
|
|
|
|
## 아직 하지 않은 것
|
|
|
|
Template CI와 Generated Application CI를 **물리적으로** 분리하지는 않았다(생성기 없음). 지금은 이
|
|
문서가 그 경계다. 생성기를 만든다면, 위 표의 "Template 전용" 열이 생성기가 벗겨 내야 할 목록이다.
|