forked from PaulDuvall/ai-development-patterns
-
Notifications
You must be signed in to change notification settings - Fork 0
435 lines (360 loc) · 13 KB
/
pattern-validation.yml
File metadata and controls
435 lines (360 loc) · 13 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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
name: AI Development Patterns Validation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
# Run weekly to catch external link issues
- cron: '0 6 * * 1'
jobs:
pattern-compliance:
runs-on: ubuntu-latest
name: Pattern Specification Compliance
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run pattern compliance tests
run: |
cd tests
python3 -m pytest test_pattern_compliance.py -v --tb=short
- name: Upload compliance test results
uses: actions/upload-artifact@v6
if: always()
with:
name: pattern-compliance-results
path: tests/test-results/
readme-accuracy:
runs-on: ubuntu-latest
name: README Accuracy & Consistency
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Update pattern count badge
run: |
python3 scripts/update-pattern-count.py
- name: Check for pattern count changes
run: |
if git diff --quiet README.md index.html; then
echo "✓ Pattern count badges are up to date"
else
echo "⚠️ Pattern count badges were updated"
git diff README.md index.html
# Fail the job if pattern count is wrong to remind developers to commit the change
echo "::error::Pattern count badges were out of date. Please run 'python3 scripts/update-pattern-count.py' and commit the changes."
exit 1
fi
- name: Run README accuracy tests
run: |
cd tests
python3 -m pytest test_readme_accuracy.py -v --tb=short
- name: Upload accuracy test results
uses: actions/upload-artifact@v6
if: always()
with:
name: readme-accuracy-results
path: tests/test-results/
link-validation:
runs-on: ubuntu-latest
name: Hyperlink Integrity
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run link validation tests (fast)
run: |
cd tests
python3 -m pytest test_links.py -v --tb=short -m "not slow"
- name: Run external link tests (slow)
run: |
cd tests
python3 -m pytest test_links.py -v --tb=short -m "slow"
continue-on-error: true # External links may be temporarily unavailable
- name: Upload link validation results
uses: actions/upload-artifact@v6
if: always()
with:
name: link-validation-results
path: tests/test-results/
example-validation:
runs-on: ubuntu-latest
name: Example Code Validation
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install bash for script validation
run: |
sudo apt-get update
sudo apt-get install -y bash
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run example validation tests
run: |
cd tests
python3 -m pytest test_examples.py -v --tb=short
- name: Upload example validation results
uses: actions/upload-artifact@v6
if: always()
with:
name: example-validation-results
path: tests/test-results/
dependency-validation:
runs-on: ubuntu-latest
name: Pattern Dependencies
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run dependency validation tests
run: |
cd tests
python3 -m pytest test_dependencies.py -v --tb=short
- name: Upload dependency validation results
uses: actions/upload-artifact@v6
if: always()
with:
name: dependency-validation-results
path: tests/test-results/
diagram-validation:
runs-on: ubuntu-latest
name: Diagram Accuracy
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run diagram validation tests
run: |
cd tests
python3 -m pytest test_diagram.py -v --tb=short
- name: Upload diagram validation results
uses: actions/upload-artifact@v6
if: always()
with:
name: diagram-validation-results
path: tests/test-results/
yaml-readme-sync:
runs-on: ubuntu-latest
name: YAML-README Sync
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run YAML-README sync tests
run: |
cd tests
python3 -m pytest test_yaml_readme_sync.py -v --tb=short
- name: Upload sync test results
uses: actions/upload-artifact@v6
if: always()
with:
name: yaml-readme-sync-results
path: tests/test-results/
comprehensive-validation:
runs-on: ubuntu-latest
name: Full Test Suite
needs: [pattern-compliance, readme-accuracy, link-validation, example-validation, dependency-validation, diagram-validation, yaml-readme-sync]
if: always()
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install bash for script validation
run: |
sudo apt-get update
sudo apt-get install -y bash
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run complete test suite
id: tests
continue-on-error: true
run: |
cd tests
python3 -m pytest -v --tb=short \
--html=report.html --self-contained-html \
--cov=utils --cov-report=html \
--json-report --json-report-file=.report.json
- name: Generate Claude Code fix prompt
if: steps.tests.outcome == 'failure'
run: |
echo "## Claude Code Fix Instructions" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Paste the prompt below into Claude Code to fix these failures:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo '````' >> $GITHUB_STEP_SUMMARY
python3 scripts/generate-audit-prompt.py tests/.report.json >> $GITHUB_STEP_SUMMARY 2>/dev/null || true
echo '````' >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Or run locally: \`/xaudit\`" >> $GITHUB_STEP_SUMMARY
- name: Fail if tests failed
if: steps.tests.outcome == 'failure'
run: exit 1
- name: Upload comprehensive test report
uses: actions/upload-artifact@v6
if: always()
with:
name: comprehensive-test-report
path: |
tests/report.html
tests/htmlcov/
tests/test-results/
tests/.report.json
quality-gates:
runs-on: ubuntu-latest
name: Quality Gate Enforcement
needs: [comprehensive-validation]
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v5
- name: Set up Python 3.11
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r tests/requirements.txt
- name: Run critical tests only (quality gates)
run: |
cd tests
# Run only critical tests that should block merges
python3 -m pytest test_pattern_compliance.py::TestPatternSpecCompliance::test_all_expected_patterns_exist -v
python3 -m pytest test_pattern_compliance.py::TestPatternSpecCompliance::test_pattern_header_structure -v
python3 -m pytest test_readme_accuracy.py::TestReadmeAccuracy::test_pattern_reference_table_matches_implementations -v
python3 -m pytest test_links.py::TestHyperlinkIntegrity::test_internal_anchor_links_valid -v
python3 -m pytest test_dependencies.py::TestPatternDependencies::test_no_circular_dependencies -v
- name: Check critical test results
run: |
echo "Quality gates passed - PR can be merged"
# Notification job for failed builds
notify-failure:
runs-on: ubuntu-latest
name: Notify on Failure
permissions:
issues: write
needs: [pattern-compliance, readme-accuracy, link-validation, example-validation, dependency-validation, diagram-validation, yaml-readme-sync]
if: failure() && github.event_name == 'push' && github.ref == 'refs/heads/main'
steps:
- name: Create Issue on Failure (skip if duplicate)
uses: actions/github-script@v8
with:
script: |
const { data: existing } = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
labels: 'pattern-validation',
state: 'open'
});
if (existing.length > 0) {
const issue = existing[0];
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `Still failing on commit ${context.sha}.\n\n[View failed run](${context.payload.repository.html_url}/actions/runs/${context.runId})`
});
core.info(`Skipped duplicate — added comment to #${issue.number}`);
return;
}
const title = `Pattern Validation Failed - ${new Date().toISOString().split('T')[0]}`;
const body = `## Pattern Validation Failure
The automated pattern validation failed on the main branch.
**Build**: ${context.runId}
**Commit**: ${context.sha}
**Workflow**: ${context.workflow}
Please review the failed checks and fix any issues with:
- Pattern specification compliance
- README accuracy and consistency
- Hyperlink integrity
- Example code validation
- Pattern dependencies
- Diagram accuracy
[View failed workflow run](${context.payload.repository.html_url}/actions/runs/${context.runId})
`;
github.rest.issues.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: title,
body: body,
labels: ['bug', 'automation', 'pattern-validation']
});
# Auto-close validation issues when all checks pass
close-resolved-issues:
runs-on: ubuntu-latest
name: Close Resolved Issues
permissions:
issues: write
needs: [pattern-compliance, readme-accuracy, link-validation, example-validation, dependency-validation, diagram-validation, yaml-readme-sync]
if: success() && github.event_name == 'push' && github.ref == 'refs/heads/main'
steps:
- name: Close pattern-validation issues
uses: actions/github-script@v8
with:
script: |
const { data: issues } = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
labels: 'pattern-validation',
state: 'open'
});
for (const issue of issues) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `All pattern validation checks passed on commit ${context.sha}. Closing automatically.\n\n[View passing run](${context.payload.repository.html_url}/actions/runs/${context.runId})`
});
await github.rest.issues.update({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
state: 'closed',
state_reason: 'completed'
});
}