-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.d-check.yml
More file actions
162 lines (151 loc) · 7.54 KB
/
Copy path.d-check.yml
File metadata and controls
162 lines (151 loc) · 7.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# Doku-Referenz-Checks via d-check (ghcr.io/pt9912/d-check).
# Der vollständige Repo-Scan schließt nur lokale, nicht versionierte
# Arbeitsartefakte aus. `codepaths` prüft aktuelle Doku; historische Pläne
# und die konzeptionellen Paketpfade der Architektur bleiben ausgenommen.
# Beschreibung siehe: https://raw.githubusercontent.com/pt9912/d-check/refs/heads/main/docs/user/benutzerhandbuch.md
scan:
roots: ['.']
# `.harness/baseline/**` ist die netzlos vendored, integritaets-gepruefte
# Regelwerk-/Template-Referenz (SHA256SUMS) — Referenzmaterial, kein
# authored Projekt-Doc. Aus dem Doku-Lint ausgenommen; die Integritaet
# traegt `sha256sum -c SHA256SUMS`, nicht `docs-check`. Kuenftige echte
# Projekt-Artefakte unter `.harness/skills/` bleiben bewusst gescannt.
ignore: ['.security/.trivy-cache/**', '.tmp/**', '.harness/baseline/**']
modules: [links, anchors, spans, tracked, codepaths, hostpaths, matrix, versions, ids]
# Modul `ids` (welle-01): Requirement-Kennungen im Fließtext müssen als
# verankerte Links auf ihre Definition zeigen (inline-`<a id>`-Anker je
# Definitionszeile, in der letzten Zelle — die ID-Zelle bleibt RTM-rein).
# Repo-weit über alle aktiven Doc-Dirs (slice-001 = Spec-Straten, slice-002 =
# Rest). F/NF/MVP/AK/RAK → `spec/lastenheft.md`; R → `risks-backlog.md`.
# Die R-Familie ist in `spec/**` exempt: der Vertrag/Technik verweist nicht
# abwärts aufs Risiko-Register (`matrix`-Richtung). Immutable ADRs
# (`docs/plan/adr/**`) + `done/` + Root-Übersichts-Docs bleiben außerhalb.
ids:
scope:
roots: [spec, docs/user, docs/dev, docs/ops, docs/perf, examples, docs/plan/planning, docs/plan/carveouts]
patterns:
# \b verhindert Über-Matches: `\bR-` trifft NICHT das `R-002` in `MR-002`
# oder `R-0001` in `ADR-0001` (M-R/D-R = keine Wortgrenze), ` R-26` schon.
- regex: '\b(F|NF|MVP|AK|RAK)-[0-9]+'
target: spec/lastenheft.md
exempt-paths: ['docs/plan/planning/done/**']
- regex: '\bR-[0-9]+'
target: docs/plan/planning/risks-backlog.md
exempt-paths: ['spec/**', 'docs/plan/planning/done/**']
# Modul `versions` (W7): gepinnte m-trace-GHCR-Image-Verweise in Markdown müssen
# die aktuelle Release-Version (aus `version.md#aktuell`) tragen. Geprüftes Live-
# Ziel: die konkreten Betriebs-Pins im Anwenderhandbuch §6. m-trace-Images nutzen
# das `:X.Y.Z`-Tag-Format (ohne `v`; der Git-Tag ist `vX.Y.Z`). Historische Pins in
# `done/`-Plänen + CHANGELOG sind Audit-Bestand → exempt. Ergänzend guardet
# `make k8s-validate` die deploy/k8s-YAML-Tags gegen die Root-`package.json`
# (YAML liegt außerhalb der Markdown-Reichweite dieses Moduls).
versions:
pin-pattern: 'ghcr\.io/pt9912/m-trace-[a-z-]+:(\d+\.\d+\.\d+)'
current-from: version.md#aktuell
exempt-paths: ['docs/plan/planning/done/**', 'CHANGELOG.md']
# W7-Advisory: `ids`/`citations`/`sources` bleiben (noch) AUS:
# - `ids`: d-check würde die ~3193 nackten Kennungen mechanisch auf Datei-Level
# linken (`[ID](ziel-datei)`, kein Anker — Anker ist laut Handbuch optional).
# m-traces Policy (conventions.md §Requirement-Link-Konvergenz) lehnt diese
# Datei-Level-Mehrdeutigkeit ab und verlangt Per-ID-Anker. Die Aktivierung mit
# verankerten Links ist als `slice-001-requirement-anker-ids` geschnitten.
# - `citations`/`sources` brauchen explizite Marker (`d-check:cite`/`dsource`);
# m-trace nutzt keine → nichts zu prüfen.
codepaths:
scope:
roots: [docs/user, docs/ops, docs/dev, docs/perf, docs/plan/adr, spec]
exempt-paths: [spec/architecture.md]
# Tombstone-Register (W5-Layout-Move, v3.5.0-Migration): die immutablen
# Accepted-ADRs (MR-002) tragen Verweise auf die Pre-Move-Pfade und duerfen
# nicht editiert werden. `ignore-refs` nimmt genau diese aufgeloesten Ziele
# von der Existenzpruefung aus (geteilt von links/anchors/codepaths),
# scoped auf die ADR-Quelldateien — mit Gate, nichts verschwindet still.
ignore-refs:
- in: 'docs/plan/adr/**'
refs:
- 'docs/planning/**' # Code-Span-Verweise auf den Alt-Planning-Pfad
- 'docs/adr/**' # Code-Span-Verweise auf den Alt-ADR-Pfad
- 'docs/plan/perf/**' # ADR-0008 ](../perf/…) post-move ins Leere
- 'docs/plan/dev/**' # ADR-0008 ](../dev/…)
- 'docs/plan/ops/**' # ADR-0007 ](../ops/…)
- 'docs/harness/**' # ADR-0009 ](../../harness/…)
hostpaths:
prefixes: [Users, Development]
# Native Tabellenquelle fuer die Requirements Traceability Matrix. `RAK-51`
# ist historisch erst als Kann und spaeter als Muss definiert; `last` bildet
# diese ausdrueckliche Hochstufung deterministisch ab.
trace:
requirements:
source: spec/lastenheft.md
id-pattern: '(F|NF|MVP|AK|RAK)-[0-9]+'
format: table
table:
id-column: Kennung
text-columns: [Anforderung, Akzeptanzkriterium]
modality-column: Prioritaet
duplicate-ids: last
modality: {}
adrs:
dir: docs/plan/adr
file-pattern: '^([0-9]{4})-.*\.md$'
id-prefix: 'ADR-'
slices:
dir: docs/plan/planning/done
# Mischt grandfathered `plan-<version>` mit der Kanon-Form `slice-<NNN>` /
# `welle-<NN>-results` (MR-007). Voll-Capture der Owner-Kennung, kein
# `id-prefix` — für `plan-*` byte-identisch zum Vorstand (verifiziert), für
# slice/welle additiv.
file-pattern: '^((?:plan|slice|welle)-.+)\.md$'
# Normative Referenzen folgen dem Stable Dependencies Principle:
# Vertrag > Technik > Sicht > ADR > Planung. Bestehende Accepted-ADRs sind
# beim Einführen des Gates explizit grandfathered; neue ADRs nicht.
matrix:
classes:
- name: contract
paths: [spec/lastenheft.md]
- name: technical-spec
paths: [spec/backend-api-contract.md, spec/browser-support.md, spec/player-sdk.md, spec/telemetry-model.md]
- name: view-spec
paths: [spec/architecture.md]
- name: adr
paths: ['docs/plan/adr/[0-9]*.md']
token: 'ADR-[0-9]{4}'
- name: planning
paths: ['docs/plan/planning/**/*.md']
token: 'plan-[0-9]+\.[0-9]+\.[0-9]+'
rules:
- {from: contract, to: technical-spec, allow: false}
- {from: contract, to: view-spec, allow: false}
- {from: contract, to: adr, allow: false}
- {from: contract, to: planning, allow: false}
- {from: technical-spec, to: view-spec, allow: false}
- {from: technical-spec, to: adr, allow: false}
- {from: technical-spec, to: planning, allow: false}
- {from: view-spec, to: adr, allow: false}
- {from: view-spec, to: planning, allow: false}
- {from: adr, to: planning, allow: false}
status:
forbidden: [superseded, deprecated]
exclude-sections: [Historie, Geschichte]
exempt-paths:
- docs/plan/adr/0001-backend-stack.md
- docs/plan/adr/0002-persistence-store.md
- docs/plan/adr/0003-live-updates.md
- docs/plan/adr/0004-cursor-strategy.md
- docs/plan/adr/0005-production-ops-backends.md
- docs/plan/adr/0006-postgres-scaleout-adapter.md
- docs/plan/adr/0007-sqlite-postgres-data-cutover.md
# Future-only-Sensoren: Sie werden über eigene Make-Targets mit Commit-Range
# oder Staged-Diff aufgerufen und gehören deshalb nicht in `modules`.
vcs:
paths: ['docs/plan/adr/[0-9]*.md']
immutable-when: '^> \*\*Status\*\*: (Accepted|\*\*Accepted \+ GELIEFERT\*\*)'
exclude-sections: [Historie, Geschichte]
status-line: '^> \*\*Status\*\*:'
head-allow: '^> \*\*Status\*\*: (Accepted.*|\*\*Accepted \+ GELIEFERT\*\*.*|Superseded.*)'
commits:
id-patterns:
- 'ADR-[0-9]{4}'
- '(F|NF|MVP|AK|RAK|R)-[0-9]+'
- 'plan-[0-9]+\.[0-9]+\.[0-9]+'
exempt-pattern: '^(Merge |Revert |docs(\([^)]*\))?: |test(\([^)]*\))?: |build(\([^)]*\))?: |ci(\([^)]*\))?: |chore(\([^)]*\))?: )'