main / main-check (push) Successful in 8m35s
옮겨 온 문서는 템플릿 안의 family를 전제로 쓰였다. 루트 지침은
하네스 뼈대의 빈 양식이고, 모듈 지침·제품 문서는 템플릿 경로
(src/platforms/messaging, src/config/…, cd src)와 템플릿 소비자
(app-bootstrap, adapter:*, composition:*)를 이 repo 안의 것처럼 부른다.
- AGENTS.md(38줄)·CLAUDE.md: 꼭 지킬 것 일곱(api 모듈 순수성, 템플릿
타입·경로 금지, 배포 버전·적용된 migration 불변, 인증 manifest 손으로
고치지 않기 등), 지도, 맡은 일, 검증 진입점.
- README.md: 받는 법(exclusiveContent dev.cakit), migration 위치, 지원 표
(Boot 4.0.9, kafka-clients 4.1.2, apache/kafka:4.1.0, PostgreSQL 16,
Java 21), 구조, 문서 지도, 서명 공개 키(지문 …A1C936D7F791F8AB,
grpc-library와 같은 키), 이력(템플릿 2959eff0에서 filter-repo).
- CHANGELOG.md: 1.0.0 절과 템플릿 안 코드에서 옮기는 법(패키지,
Kafka 설정 키, Gradle 좌표, 바뀌지 않는 것).
- docs/README.md, docs/work/{README,gates,release}.md,
docs/problem-statement.md: grpc-library와 같은 모양으로, 메시징의
인증 증거 게이트·migration 규칙·템플릿과 같이 고치는 경로를 넣었다.
docs/vision.md는 소유자가 쓸 자리라 비워 둔다.
- messaging/AGENTS.md, docs/messaging/*, starter README: registry 경로를
이 repo 기준으로, 템플릿 쪽 경로·타입은 「백엔드 템플릿의」로 밝혔다.
시험이 읽는 문장(지원 표의 broker·버전, 설정 참조의 YAML)은 바꾸지
않았다.
검증: scripts/verify.sh docs rc=0(vision.md 자리 알림만). desktop
mainCheck는 이 커밋 직전 트리에서 rc=0이었다. 문서가 시험에 읽히는
부분은 다음 desktop 실행으로 다시 본다.
Refs: design-docs repo-structure/05-library-repos.md 14.2절
34 lines
3.2 KiB
Markdown
34 lines
3.2 KiB
Markdown
# 게이트 — 무엇을 언제 돌리나
|
|
|
|
단계 태스크는 루트 `build.gradle`이 정한다. workflow는 단계마다 Gradle 한 줄이고, 어떤 모듈·lane·검사가 들어가는지는 workflow가 아니라 Gradle이 정한다.
|
|
|
|
## 1. 단계
|
|
|
|
| 단계 | 언제 | 명령(`scripts/verify.sh`) | 들어 있는 것 |
|
|
| --- | --- | --- | --- |
|
|
| `ci` | PR(`pr.yml`) | `pr` | 모듈 `check` 전부(단위 시험, Spotless, Checkstyle, Error Prone, `messaging-testkit`의 저장소 계약 lane), SpotBugs(main·test), lockfile, `architectureCheck`, build-logic 시험. 그리고 `verifyStrictLaneStages --dry-run` |
|
|
| `mainCheck` | main push·매일 03:30 KST(`main.yml`) | `main` | `ci` + `integrationCheck`(Testcontainers Kafka·Toxiproxy·PostgreSQL) + 브로커 인증 증거 게이트 `verifyMessagingCertificationEvidence` |
|
|
| `releaseCheck` | `vX.Y.Z` 태그(`release.yml`) | `release` | 버전 확인, hermetic lane(`testLaneCheck`), `integrationCheck`, 인증 증거 게이트, SBOM, 의존성 취약점 검사 |
|
|
| `release` | `vX.Y.Z` 태그 | — | `releaseCheck` 뒤 Gitea Packages에 서명해 올리고 익명으로 다시 읽는다 |
|
|
| `releaseRehearsal` | 손으로 | `release` | `releaseCheck` 뒤 `build/staging-repository`에 올리고 파일마다 확인. 비밀 값 없이 돈다 |
|
|
|
|
성능 lane은 없다. `messaging-kafka`·`messaging-testkit`의 JMH 벤치마크(`./gradlew :messaging:<모듈>:jmh`)는 게이트가 아니다.
|
|
|
|
## 2. 바꾼 것에 맞는 게이트
|
|
|
|
| 바꾼 것 | 최소로 돌릴 것 |
|
|
| --- | --- |
|
|
| 모듈 하나의 코드 | `./gradlew <gradle path>:check`(path는 registry), 끝나기 전에 `scripts/verify.sh pr` |
|
|
| `messaging-kafka`, 전달 보장·실패 분류 | 위 + `./gradlew :messaging:messaging-kafka:verifyMessagingCertificationEvidence`(Docker). 시나리오가 바뀌면 만들어진 `build/messaging-certification/broker-certification-evidence.jsonl`을 `messaging-testkit/src/main/resources/messaging/`에 덮어 같은 변경에 넣는다 |
|
|
| `messaging-reliability*`, migration, starter 조립 | 위 + `./gradlew integrationCheck`(Docker) |
|
|
| 모듈의 `api`·`implementation` 범위, 공개 시그니처, `app.messaging` 설정 타입 | `./gradlew :messaging:messaging-testkit:repositoryContractTest` |
|
|
| `build.gradle`, `build-logic/`, registry, workflow | `scripts/verify.sh pr`(lane 단계 검사가 workflow를 읽는다) |
|
|
| 의존성 버전, lockfile | `./gradlew resolveAndLockAll --write-locks` 후 `scripts/verify.sh pr`, 릴리스 전이면 `scripts/verify.sh release` |
|
|
| 테스트 컨테이너 이미지(`config/testing/container-images.properties`) | `scripts/verify.sh main`. Kafka 이미지가 바뀌면 인증 manifest도 다시 만든다(위 `messaging-kafka` 줄) |
|
|
|
|
## 3. 증거로 남길 때
|
|
|
|
- 게이트, rc, 실행 직전 부하(`uptime`), 로그 경로, 대상 트리(커밋 또는 `git write-tree`), 캐시를 썼는지를 적는다.
|
|
- 증거로 쓰는 실행은 `--rerun-tasks`로 캐시 결과를 쓰지 않는다. 테스트 수는 `build/test-results/**.xml`에서 센다.
|
|
- 인증 증거 줄의 `gitCommit`은 lane이 `GITHUB_SHA`(없으면 `local`)로 적는 출처다. 게이트는 `gitCommit`·`observedAt`을 빼고 시나리오 집합을 비교한다.
|