docs(ci): 단계·job 설명과 링크 검사 범위를 지금 workflow에 맞춘다 #18

Merged
donghyeon.kang merged 2 commits from claude/w2-be-ci-perf-3 into main 2026-11-12 16:59:59 +00:00
2 Commits
Author SHA1 Message Date
DongHyeonka 3272faeb38 docs(ci): 단계·job 설명을 지금 workflow와 빌드에 맞춘다
pr / done (pull_request) Successful in 11m34s
round9 확인 리뷰가 CI 파일의 설명이 실제와 다른 곳을 짚었다.

- verify.sh 머리 표: PR 단계 job 이름이 `gradle`이다. 실제는 `done`.
- build.gradle: JMH가 「세 leaf」에 있다고 하지만 지금은 플러그인을
  쓰는 leaf가 정한다. verifyFeatureScaffold는 「leaf 다섯 중첩
  빌드」라고 하지만 그 안의 architectureCheck가 모든 leaf의
  architecture lane을 부른다.
- release.yml: `release` job 주석은 「ci를 다시 돌리지 않는다」인데
  뒤의 job들은 ci가 이미 돈 시험 일부를 다시 돈다. 그 이유(문서가
  job id로 부르는 릴리스 증거이고, 이미지 job이 모두를 needs로 받아
  같은 run·같은 커밋에서 통과한 뒤 publish한다)를 적었다. job은 그대로다.
- gates.md 2절: redis-topology 줄을 desktop에서 그대로 돌리라고 하지만
  스크립트 안 ./gradlew는 daemon을 남긴다. desktop에서는
  GRADLE_OPTS=-Dorg.gradle.daemon=false를 붙이라고 적었다. 스크립트에
  --no-daemon을 넣지 않은 이유: CI는 한 job의 step 11개가 daemon을
  다시 쓴다.
- redis-sdk compose README: cache-redis 칸에 필수 클래스가 둘뿐이다.
  build.gradle의 standalone·cluster 목록 다섯으로 맞췄다.
- template-vs-consumer.md: object-storage-aws를 nightly job으로 적었다.
  실제는 손으로 실행하고 입력 run_protected_aws를 켤 때만 돈다. 최상위
  항목을 더하면 「AGENTS.md 지도를 함께 고친다」고 했지만 지도는 루트
  목록을 두지 않고 check-repo-layout.py를 가리킨다. src/ 최상위 폴더일
  때만 지도의 src/ 줄을 고친다고 적었다.

동작 변경 없음: workflow는 주석만, 스크립트는 머리 주석만 바꿨다.

검증: scripts/verify.sh docs(노트북) rc=0.

Refs: round9 확인 리뷰(r9-be wave1-r4 「넘길 것」)
2026-11-12 21:36:05 +09:00
DongHyeonka bf612f1051 ci(main): lychee가 폴더 CLAUDE.md 대신 AGENTS.md를 본다
main.yml `links`의 lychee 범위에 `src/**/CLAUDE.md`가 있다. 폴더
지역 규칙이 같은 폴더 AGENTS.md로 옮겨 간 뒤 CLAUDE.md는
`@AGENTS.md` 한 줄이라 링크가 하나도 없다. 외부 URL이 있는
`src/**/AGENTS.md`는 범위 밖이라 그 링크가 죽어도 아무 단계도
모른다(상대 링크는 PR의 check-docs.py가 본다).

범위의 그 한 칸을 `src/**/AGENTS.md`로 바꾼다. 범위를 고정하는
DeveloperExperienceContractTest와 gates.md 2절 링크 검사 문장도 함께
바꾼다. 버린 안: 두 패턴을 다 두기 — 링크 없는 파일을 매번 읽을 뿐이다.

위험: 새로 보는 외부 링크는 messaging-kafka AGENTS.md의 Gitea 링크
하나다(코드 span 밖 URL 기준). 익명 GET이 200이라 runner에서도
통과할 것으로 본다. main push의 links job에서 확인한다.

검증: scripts/verify.sh docs(노트북) rc=0. Gradle 쪽
(DeveloperExperienceContractTest)은 PR 실행과 desktop verify.sh pr로 본다.
2026-11-12 21:36:05 +09:00