Skip to content

Commit e1ca48a

Browse files
Update agents, xUnit, review-sets, verification-doc, etc. (#78)
* Update agents, xUnit, review-sets, verification-doc, etc. * Update pandoc definition.yaml files for generated files. * More updates based on reviews. * Fix user guide metadata and checks. * Fix troubleshooting docs: reflect fail-fast capture behavior Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/d2b8f462-9fd9-4f3d-a6be-dba84786e87c Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 8c08586 commit e1ca48a

105 files changed

Lines changed: 2835 additions & 1340 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.cspell.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ words:
1919
- Dema
2020
- fileassert
2121
- msbuild
22-
- mstest
22+
- opencover
2323
- pandoc
2424
- reqstream
2525
- reviewmark
@@ -29,6 +29,8 @@ words:
2929
- versionmark
3030
- weasyprint
3131
- Weasy
32+
- xunit
33+
- Xunit
3234
- yamlfix
3335

3436
# Exclude common build artifacts, dependencies, and vendored third-party code
@@ -39,6 +41,7 @@ ignorePaths:
3941
- "**/thirdparty/**"
4042
- "**/third-party/**"
4143
- "**/3rd-party/**"
44+
- "**/generated/**"
4245
- "**/AGENT_REPORT_*.md"
4346
- "**/.agent-logs/**"
4447
- "**/bin/**"

.fileassert.yaml

Lines changed: 51 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# FileAssert document validation tests for VersionMark.
33
# Tests are tagged by document group to allow per-group execution during the build pipeline.
4-
# Tags: build-notes, code-quality, code-review, design, user-guide, requirements.
4+
# Tags: build-notes, code-quality, code-review, design, verification, user-guide, requirements.
55
#
66
# NOTE: build-notes through user-guide tests provide OTS evidence for Pandoc and WeasyPrint
77
# and run before ReqStream. The requirements tests run after ReqStream and validate the
@@ -15,7 +15,7 @@ tests:
1515
description: "Build Notes HTML was generated by Pandoc"
1616
tags: [build-notes]
1717
files:
18-
- pattern: "docs/build_notes/build_notes.html"
18+
- pattern: "docs/build_notes/generated/build_notes.html"
1919
count: 1
2020
html:
2121
- query: "//head/title"
@@ -27,7 +27,7 @@ tests:
2727
description: "Build Notes PDF was generated by WeasyPrint"
2828
tags: [build-notes]
2929
files:
30-
- pattern: "docs/VersionMark Build Notes.pdf"
30+
- pattern: "docs/generated/VersionMark Build Notes.pdf"
3131
count: 1
3232
pdf:
3333
metadata:
@@ -48,7 +48,7 @@ tests:
4848
description: "Code Quality HTML was generated by Pandoc"
4949
tags: [code-quality]
5050
files:
51-
- pattern: "docs/code_quality/quality.html"
51+
- pattern: "docs/code_quality/generated/quality.html"
5252
count: 1
5353
html:
5454
- query: "//head/title"
@@ -60,7 +60,7 @@ tests:
6060
description: "Code Quality PDF was generated by WeasyPrint"
6161
tags: [code-quality]
6262
files:
63-
- pattern: "docs/VersionMark Code Quality.pdf"
63+
- pattern: "docs/generated/VersionMark Code Quality.pdf"
6464
count: 1
6565
pdf:
6666
metadata:
@@ -81,7 +81,7 @@ tests:
8181
description: "Code Review Plan HTML was generated by Pandoc"
8282
tags: [code-review]
8383
files:
84-
- pattern: "docs/code_review_plan/plan.html"
84+
- pattern: "docs/code_review_plan/generated/plan.html"
8585
count: 1
8686
html:
8787
- query: "//head/title"
@@ -93,7 +93,7 @@ tests:
9393
description: "Code Review Plan PDF was generated by WeasyPrint"
9494
tags: [code-review]
9595
files:
96-
- pattern: "docs/VersionMark Review Plan.pdf"
96+
- pattern: "docs/generated/VersionMark Review Plan.pdf"
9797
count: 1
9898
pdf:
9999
metadata:
@@ -114,7 +114,7 @@ tests:
114114
description: "Code Review Report HTML was generated by Pandoc"
115115
tags: [code-review]
116116
files:
117-
- pattern: "docs/code_review_report/report.html"
117+
- pattern: "docs/code_review_report/generated/report.html"
118118
count: 1
119119
html:
120120
- query: "//head/title"
@@ -126,7 +126,7 @@ tests:
126126
description: "Code Review Report PDF was generated by WeasyPrint"
127127
tags: [code-review]
128128
files:
129-
- pattern: "docs/VersionMark Review Report.pdf"
129+
- pattern: "docs/generated/VersionMark Review Report.pdf"
130130
count: 1
131131
pdf:
132132
metadata:
@@ -147,7 +147,7 @@ tests:
147147
description: "Design HTML was generated by Pandoc"
148148
tags: [design]
149149
files:
150-
- pattern: "docs/design/design.html"
150+
- pattern: "docs/design/generated/design.html"
151151
count: 1
152152
html:
153153
- query: "//head/title"
@@ -159,7 +159,7 @@ tests:
159159
description: "Design PDF was generated by WeasyPrint"
160160
tags: [design]
161161
files:
162-
- pattern: "docs/VersionMark Software Design.pdf"
162+
- pattern: "docs/generated/VersionMark Software Design.pdf"
163163
count: 1
164164
pdf:
165165
metadata:
@@ -174,13 +174,46 @@ tests:
174174
text:
175175
- contains: "Design"
176176

177+
# --- VERIFICATION ---
178+
179+
- name: Pandoc_VerificationHtml
180+
description: "Verification HTML was generated by Pandoc"
181+
tags: [verification]
182+
files:
183+
- pattern: "docs/verification/generated/verification.html"
184+
count: 1
185+
html:
186+
- query: "//head/title"
187+
count: 1
188+
text:
189+
- contains: "Verification"
190+
191+
- name: WeasyPrint_VerificationPdf
192+
description: "Verification PDF was generated by WeasyPrint"
193+
tags: [verification]
194+
files:
195+
- pattern: "docs/generated/VersionMark Software Verification Design.pdf"
196+
count: 1
197+
pdf:
198+
metadata:
199+
- field: "Title"
200+
contains: "Verification"
201+
- field: "Author"
202+
contains: "DEMA Consulting"
203+
- field: "Subject"
204+
contains: "Verification design document"
205+
pages:
206+
min: 3
207+
text:
208+
- contains: "Verification"
209+
177210
# --- USER GUIDE ---
178211

179212
- name: Pandoc_UserGuideHtml
180213
description: "User Guide HTML was generated by Pandoc"
181214
tags: [user-guide]
182215
files:
183-
- pattern: "docs/user_guide/user_guide.html"
216+
- pattern: "docs/user_guide/generated/user_guide.html"
184217
count: 1
185218
html:
186219
- query: "//head/title"
@@ -192,7 +225,7 @@ tests:
192225
description: "User Guide PDF was generated by WeasyPrint"
193226
tags: [user-guide]
194227
files:
195-
- pattern: "docs/VersionMark User Guide.pdf"
228+
- pattern: "docs/generated/VersionMark User Guide.pdf"
196229
count: 1
197230
pdf:
198231
metadata:
@@ -201,7 +234,7 @@ tests:
201234
- field: "Author"
202235
contains: "DEMA Consulting"
203236
- field: "Subject"
204-
contains: "Reference Implementation"
237+
contains: "User guide"
205238
pages:
206239
min: 3
207240
text:
@@ -214,7 +247,7 @@ tests:
214247
description: "Requirements HTML was generated by Pandoc"
215248
tags: [requirements]
216249
files:
217-
- pattern: "docs/requirements_doc/requirements.html"
250+
- pattern: "docs/requirements_doc/generated/requirements.html"
218251
count: 1
219252
html:
220253
- query: "//head/title"
@@ -226,7 +259,7 @@ tests:
226259
description: "Requirements PDF was generated by WeasyPrint"
227260
tags: [requirements]
228261
files:
229-
- pattern: "docs/VersionMark Requirements.pdf"
262+
- pattern: "docs/generated/VersionMark Requirements.pdf"
230263
count: 1
231264
pdf:
232265
metadata:
@@ -248,7 +281,7 @@ tests:
248281
description: "Trace Matrix HTML was generated by Pandoc"
249282
tags: [requirements]
250283
files:
251-
- pattern: "docs/requirements_report/trace_matrix.html"
284+
- pattern: "docs/requirements_report/generated/trace_matrix.html"
252285
count: 1
253286
html:
254287
- query: "//head/title"
@@ -260,7 +293,7 @@ tests:
260293
description: "Trace Matrix PDF was generated by WeasyPrint"
261294
tags: [requirements]
262295
files:
263-
- pattern: "docs/VersionMark Trace Matrix.pdf"
296+
- pattern: "docs/generated/VersionMark Trace Matrix.pdf"
264297
count: 1
265298
pdf:
266299
metadata:

.github/agents/developer.agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Perform software development tasks by determining and applying appropriate stand
2121
5. **Formatting**: Run `pwsh ./fix.ps1` to silently apply all
2222
available auto-fixers (dotnet format, markdown, YAML) before committing
2323
6. **Build and test** (code changes only): Run `pwsh ./build.ps1` and confirm it
24-
passes report FAILED if the build or any tests fail
24+
passes - report FAILED if the build or any tests fail
2525
7. **Generate completion report** per the AGENTS.md reporting requirements - save to
2626
`.agent-logs/{agent-name}-{subject}-{unique-id}.md` and return the summary to the caller
2727

.github/agents/formal-review.agent.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Before reviewing, read these standards to inform review judgments:
2020
hierarchy and categorization review judgments
2121
- **`design-documentation.md`** - defines mandatory sections, structural conventions,
2222
and coverage expected at each level; informs all design documentation review judgments
23+
- **`verification-documentation.md`** - defines mandatory sections, structural conventions,
24+
and coverage expected at each level; informs all verification design review judgments
2325

2426
For review sets that include source code or tests, also consult the relevant
2527
standards from the selection matrix in AGENTS.md.

.github/agents/lint-fix.agent.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,12 @@ submission, not during normal development.
3636

3737
- **markdownlint MD013 (line length)**: Wrap long lines at natural break points,
3838
after commas, before conjunctions, or at sentence boundaries. Do not break
39-
in the middle of a code span or URL.
39+
in the middle of a code span or URL. **Pipe-tables that cannot be wrapped
40+
without breaking structure** are a special case - convert them to a bullet
41+
list if the data reads naturally that way, or rewrite as a
42+
[grid table](https://pandoc.org/MANUAL.html#tables) if a tabular layout is
43+
essential. Do not get stuck trying to squeeze a wide pipe-table into 120
44+
characters.
4045

4146
- **markdownlint other rules**: Apply the specific fix indicated in the output
4247
(e.g., missing blank lines, heading levels, code fence languages).

.github/agents/repo-consistency.agent.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,19 @@ Before submitting this pull request, ensure you have completed the following:
2626

2727
### Build and Test
2828

29-
- [ ] Code builds successfully: `dotnet build --configuration Release`
30-
- [ ] All unit tests pass: `dotnet test --configuration Release`
31-
- [ ] Self-validation tests pass:
32-
`dotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0`
33-
`--no-build -- --validate`
29+
- [ ] Code builds successfully and all tests pass: `pwsh ./build.ps1`
3430
- [ ] Code produces zero warnings
3531

3632
### Code Quality
3733

38-
- [ ] Code formatting is correct: `dotnet format --verify-no-changes`
3934
- [ ] New code has appropriate XML documentation comments
4035
- [ ] Static analyzer warnings have been addressed
4136

4237
### Quality Checks
4338

4439
Please run the following checks before submitting:
4540

46-
- [ ] **Spell checker passes**: `cspell "**/*.{md,cs}"`
47-
- [ ] **Markdown linter passes**: `markdownlint "**/*.md"`
48-
- [ ] **YAML linter passes**: `yamllint .`
41+
- [ ] **All linters pass**: `pwsh ./lint.ps1`
4942

5043
### Testing
5144

@@ -57,7 +50,7 @@ Please run the following checks before submitting:
5750
### Documentation
5851

5952
- [ ] Updated README.md (if applicable)
60-
- [ ] Updated ARCHITECTURE.md (if applicable)
53+
- [ ] Updated docs/ documentation (if applicable)
6154
- [ ] Added code examples for new features (if applicable)
6255
- [ ] Updated requirements.yaml (if applicable)
6356

0 commit comments

Comments
 (0)