ci(docs): 참조 검사가 루트 compose 폴더 경로도 본다
문제: 구조 정리로 저장소 루트에 `compose/`(개발 compose의 보조 파일)가 생겼다. 참조 검사는 `src/`, `docs/`, `scripts/`, `infra/`, `.github/`로 시작하는 인라인 코드만 본다. 그래서 살아 있는 문서가 가리키는 `compose/redis/acl/README.md` 같은 경로는 파일이 옮겨지거나 지워져도 걸리지 않는다. 지금 살아 있는 문서 여덟 개가 `compose/` 경로를 쓴다. 고친 방법: PATH_ROOTS에 `compose/`를 더한다. 정본 design-docs `conventions/docs-system.md` K3는 「repo 경로」 전체를 말하고 접두사 목록을 정하지 않으므로 규칙 변경이 아니라 새 루트 폴더를 적용한 것이다. 지운 `infra/`는 남겨 둔다(다시 쓰이면 낡은 참조로 걸린다). 루트 파일 (`compose.yaml` 등)은 지금처럼 보지 않는다. 위험·한계: 새로 걸린 참조는 없다(지금 트리의 `compose/` 참조는 모두 있다). 검증: 새 시험 `test_a_missing_path_under_the_root_compose_folder_fails`가 고치기 전 실패(RED: 오류 목록이 비어 있음), 고친 뒤 43개 모두 통과. check-docs.py rc=0(참조 걸림 7·예외 7).
This commit is contained in:
@@ -10,9 +10,10 @@
|
||||
head 기록(docs/design, docs/history, docs/adr, docs/notification/adr)의 .md는 맨 위에
|
||||
머리 블록이 있다. 상태는 종류별 고정 어휘, 작성일은 날짜, 요약은 한국어, 현재
|
||||
정본과 대체됨이 가리키는 경로는 지금 있다.
|
||||
reference 살아 있는 문서의 인라인 코드 안 repo 경로(src/, docs/, scripts/, infra/, .github/로
|
||||
시작)와 Gradle 경로(:a:b)가 지금 트리와 registry에 있다. 코드 블록과 「이력」으로
|
||||
시작하는 인용 블록은 건너뛴다. 마크다운 링크는 lychee와 check-work-docs.py --links가 본다.
|
||||
reference 살아 있는 문서의 인라인 코드 안 repo 경로(src/, docs/, scripts/, compose/, .github/로
|
||||
시작. 2026-11-07에 지운 infra/ 아래 경로도 본다)와 Gradle 경로(:a:b)가 지금 트리와
|
||||
registry에 있다. 코드 블록과 「이력」으로 시작하는 인용 블록은 건너뛴다. 마크다운
|
||||
링크는 lychee와 check-work-docs.py --links가 본다.
|
||||
number 살아 있는 문서가 정본이 정하는 숫자를 복사하지 않는다: Spring Boot 버전, leaf 개수.
|
||||
|
||||
예외 목록(scripts/check-docs-exceptions.txt)은 줄기만 한다.
|
||||
@@ -142,7 +143,7 @@ TOKEN = re.compile(r"[^\s가-힣]+")
|
||||
WORD = re.compile(r"^[(\[\"'“‘*_]*[A-Za-z][a-z]*(?:['’][a-z]+)?(?:-[a-z]+)*[)\]\"'”’*_.,;:!?…]*$")
|
||||
|
||||
# --- 참조
|
||||
PATH_ROOTS = ("src/", "docs/", "scripts/", "infra/", ".github/")
|
||||
PATH_ROOTS = ("src/", "docs/", "scripts/", "compose/", "infra/", ".github/")
|
||||
PLACEHOLDER = re.compile(r"[*?<>{}\[\]$…]|\.\.\.|YYYY|NNN|[가-힣]")
|
||||
LINE_SUFFIX = re.compile(r"(?::\d+(?:[-,]\d+)*)+$")
|
||||
# 모든 leaf에 있는 소스 세트 이름(src/test, src/main/java)은 어느 leaf의 것인지 문장이 정한다.
|
||||
|
||||
Reference in New Issue
Block a user