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로 본다.
This commit is contained in:
+8
-1
@@ -209,6 +209,12 @@ tasks.register('verifyRepositoryLayout', Exec) {
|
||||
workingDir = repositoryRoot
|
||||
commandLine 'python3', 'scripts/check-repo-layout.py'
|
||||
}
|
||||
tasks.register('verifyWorkDocs', Exec) {
|
||||
group = 'verification'
|
||||
description = 'Checks the work manual: size limits, no history IDs, playbook skeleton, relative links.'
|
||||
workingDir = repositoryRoot
|
||||
commandLine 'python3', 'scripts/check-work-docs.py'
|
||||
}
|
||||
tasks.register('testDocumentChecks', Exec) {
|
||||
group = 'verification'
|
||||
description = 'Runs the tests of the scripts outside Gradle (document checker, hooks, ledger).'
|
||||
@@ -225,11 +231,12 @@ tasks.register('documentCheck', Exec) {
|
||||
|
||||
tasks.register('prCheck') {
|
||||
group = 'verification'
|
||||
description = 'The pull-request stage: ci, dependency locks, the Compose render, the layout and the documents.'
|
||||
description = 'The pull-request stage: ci, dependency locks, the Compose render, the layout, the work manual and the documents.'
|
||||
dependsOn tasks.named('ci')
|
||||
dependsOn tasks.named('verifyDependencyLocks')
|
||||
dependsOn tasks.named('verifyComposeProfiles')
|
||||
dependsOn tasks.named('verifyRepositoryLayout')
|
||||
dependsOn tasks.named('verifyWorkDocs')
|
||||
dependsOn tasks.named('documentCheck')
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -29,7 +29,7 @@ Checkstyle은 **포매터가 표현할 수 없는 것만** — 네이밍과 몇
|
||||
| `integrationCheck` | 선언된 strict integration lane을 실행. 대부분 container runtime이 필요. 입력이 필요한 lane(Redis topology: `-Predis.topology.mode`, AWS: 보호 자격 증명 env)은 입력이 없으면 빠지고 집계가 그 이유를 출력 |
|
||||
| `performanceCheck` | 선언된 strict performance lane(부하·종료·pool·자원 상한)을 실행. 실서버·container가 필요. 상한은 매번 단언하고 끄는 속성이 없다(`-Pperformance.assertions.enabled`가 `true`가 아니면 실패, skip된 테스트가 있어도 실패). `main.yml` `performance` job이 nightly에 다른 무거운 job 뒤에서 같은 명령으로 돌림 |
|
||||
| `verifyStrictLaneStages` | `--dry-run` 전용. `explicitOnly`가 아닌 strict lane이 `strictLaneStages`에 선언한 단계(`prCheck`·`mainCheck`·`integrationCheck`·`performanceCheck`·`releaseCheck`) 중 하나의 계획에 있는지, 단계마다 선언한 workflow job이 `./gradlew <단계>`를 정해진 한 줄로 조건 없이(또는 선언한 조건으로) 돌리는지 검사. 형식은 `build-logic/AGENTS.md` 「단계 job의 모양」. PR 단계가 돌림 |
|
||||
| `prCheck` | PR 단계: `ci` + `verifyDependencyLocks` + compose 렌더링(`verifyComposeProfiles`) + 저장소 배치(`verifyRepositoryLayout`) + 문서 검사(`documentCheck`) |
|
||||
| `prCheck` | PR 단계: `ci` + `verifyDependencyLocks` + compose 렌더링(`verifyComposeProfiles`) + 저장소 배치(`verifyRepositoryLayout`) + 작업 지침 분량·이력 ID(`verifyWorkDocs`) + 문서 검사(`documentCheck`) |
|
||||
| `ci` | 모든 leaf `check`(API surface 검사 포함, 소유자 결정 20) + `architectureCheck` + `qualityCheck` |
|
||||
| `mainCheck` | main 단계: `configContractCheck` + `qualificationCheck` + `verifyPublicPathSnapshot` + 전송·메시징 qualification 레인 + 각 leaf의 `mainCheck`(문서 대조 레인 `*DocumentContractTest`, objectstorage MinIO 레인) |
|
||||
| `releaseCheck` | tag 전용 검사: `verifyReleaseProvenance` + `verifyPublicPathSnapshot`(`ci`를 다시 돌리지 않음) |
|
||||
|
||||
@@ -34,6 +34,7 @@
|
||||
| `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` 지도를 함께 고친다 |
|
||||
|
||||
@@ -35,9 +35,10 @@ workflow에만 있는 job: `pr.yml` `done`의 마지막 step과 `main.yml`의 `v
|
||||
| `qualityCheck` | SpotBugs, FindSecBugs(운영 코드) | PR(`ci` 안) | `build.gradle` |
|
||||
| `testQualityCheck` | 같은 분석을 모든 테스트 source set에(`config/spotbugs/exclude-test.xml` 기준) | main(`mainCheck` 안) | `build.gradle` |
|
||||
| `ci` | leaf `check`(API surface 포함) + `architectureCheck` + `qualityCheck` | PR(`prCheck` 안) | `build.gradle` |
|
||||
| `prCheck` | `ci` + `verifyDependencyLocks` + `verifyComposeProfiles`(compose lane이 선언대로 렌더링되는가) + `verifyRepositoryLayout`(`check-repo-layout.py`) + `documentCheck`(`check-docs.py`, 앞에 `scripts/tests` 자기 시험) | PR | `pr.yml` `done`: `./gradlew :prCheck` |
|
||||
| `prCheck` | `ci` + `verifyDependencyLocks` + `verifyComposeProfiles`(compose lane이 선언대로 렌더링되는가) + `verifyRepositoryLayout`(`check-repo-layout.py`) + `verifyWorkDocs`(`check-work-docs.py`) + `documentCheck`(`check-docs.py`, 앞에 `scripts/tests` 자기 시험) | PR | `pr.yml` `done`: `./gradlew :prCheck` |
|
||||
| `verifyStrictLaneStages --dry-run` | `explicitOnly`가 아닌 strict lane이 단계 태스크 하나의 계획에 들어 있는가(그래프 검사), 단계마다 선언한 workflow job이 `./gradlew <단계>` 한 줄을 정해진 조건으로 돌리는가(형식 검사) | PR | `pr.yml` `done` 둘째 줄. 형식은 `build-logic/AGENTS.md` |
|
||||
| `python3 scripts/check-repo-layout.py` | 저장소 루트와 `src/` 최상위에 허용 목록 밖의 항목이 없는가, registry 경로가 허용 폴더 안인가. 아무도 가리키지 않는 compose·스크립트 파일은 경고 | PR(`prCheck` 안) | `verifyRepositoryLayout` |
|
||||
| `python3 scripts/check-work-docs.py` | 작업 지침(루트 `AGENTS.md`·`CLAUDE.md`, `docs/work/`, `src/**/AGENTS.md`, `.claude/`)의 분량 상한, 본문 이력 ID 0, playbook 뼈대, 상대 링크 | PR(`prCheck` 안) | `verifyWorkDocs` |
|
||||
| `python3 scripts/check-docs.py` | 살아 있는 문서의 언어, 기록·ADR 머리 블록, 문서의 인라인 코드 경로·Gradle 경로가 지금 있는가, 복사한 숫자, 상대 링크(`docs/README.md` 「문서 검사」) | PR(`prCheck` 안) | `documentCheck` |
|
||||
| `mainCheck` | `configContractCheck` + `qualificationCheck`(`testQualityCheck` 포함) + 공개 경로 스냅숏 + 전송·메시징 qualification lane + 생성 명령 왕복(`verifyFeatureScaffold`) + 모든 leaf의 `mainCheck`(document-contract lane 등) | main | `main.yml` `main`: `./gradlew :integrationCheck :mainCheck --continue` |
|
||||
| `integrationCheck` | 선언된 strict integration lane 전체(실 컨테이너). 입력이 없는 lane은 빼고 이름을 댄다 | main·nightly | `main.yml` `main`: `./gradlew :integrationCheck :mainCheck --continue`(두 단계를 Gradle 한 번에. 한 번 컴파일하고, 직렬 lane이 도는 동안 나머지가 겹친다. integration이 앞이라 lane이 첫 몇 분부터 슬롯을 쓴다) |
|
||||
|
||||
Reference in New Issue
Block a user