Add ReviewMark integration (review plan, review report, multi-set config, ValidationTests)

.config/dotnet-tools.json

@@ -49,6 +49,12 @@
       "commands": [
         "versionmark"
       ]
+    },
+    "demaconsulting.reviewmark": {
+      "version": "0.1.0-rc.3",
+      "commands": [
+        "reviewmark"
+      ]
     }
   }
 }

.cspell.json

@@ -44,6 +44,10 @@
     "Qube",
     "reqstream",
     "ReqStream",
+    "reviewmark",
+    "ReviewMark",
+    "reviewplan",
+    "reviewreport",
     "Sarif",
     "SarifMark",
     "SBOM",

.github/workflows/build.yaml

@@ -462,7 +462,7 @@ jobs:
           echo "Capturing tool versions..."
           dotnet versionmark --capture --job-id "build-docs" \
             --output "artifacts/versionmark-build-docs.json" -- \
-            dotnet git node npm pandoc weasyprint sarifmark sonarmark reqstream buildmark versionmark
+            dotnet git node npm pandoc weasyprint sarifmark sonarmark reqstream buildmark versionmark reviewmark
           echo "✓ Tool versions captured"
 
       # === CAPTURE OTS SELF-VALIDATION RESULTS ===
@@ -484,6 +484,9 @@ jobs:
       - name: Run SonarMark self-validation
         run: dotnet sonarmark --validate --results artifacts/sonarmark-self-validation.trx
 
+      - name: Run ReviewMark self-validation
+        run: dotnet reviewmark --validate --results artifacts/reviewmark-self-validation.trx
+
       # === GENERATE MARKDOWN REPORTS ===
       # This section generates all markdown reports from various tools and sources.
       # Downstream projects: Add any additional markdown report generation steps here.
@@ -531,6 +534,28 @@ jobs:
           echo "=== SonarCloud Quality Report ==="
           cat docs/quality/sonar-quality.md
 
+      - name: Generate Review Plan and Review Report with ReviewMark
+        shell: bash
+        run: >
+          dotnet reviewmark
+          --definition .reviewmark.yaml
+          --plan docs/reviewplan/review-plan.md
+          --plan-depth 1
+          --report docs/reviewreport/review-report.md
+          --report-depth 1
+
+      - name: Display Review Plan
+        shell: bash
+        run: |
+          echo "=== Review Plan ==="
+          cat docs/reviewplan/review-plan.md
+
+      - name: Display Review Report
+        shell: bash
+        run: |
+          echo "=== Review Report ==="
+          cat docs/reviewreport/review-report.md
+
       - name: Generate Build Notes with BuildMark
         shell: bash
         env:
@@ -625,6 +650,26 @@ jobs:
           --metadata date="$(date +'%Y-%m-%d')"
           --output docs/tracematrix/tracematrix.html
 
+      - name: Generate Review Plan HTML with Pandoc
+        shell: bash
+        run: >
+          dotnet pandoc
+          --defaults docs/reviewplan/definition.yaml
+          --filter node_modules/.bin/mermaid-filter.cmd
+          --metadata version="${{ inputs.version }}"
+          --metadata date="$(date +'%Y-%m-%d')"
+          --output docs/reviewplan/review-plan.html
+
+      - name: Generate Review Report HTML with Pandoc
+        shell: bash
+        run: >
+          dotnet pandoc
+          --defaults docs/reviewreport/definition.yaml
+          --filter node_modules/.bin/mermaid-filter.cmd
+          --metadata version="${{ inputs.version }}"
+          --metadata date="$(date +'%Y-%m-%d')"
+          --output docs/reviewreport/review-report.html
+
       # === GENERATE PDF DOCUMENTS WITH WEASYPRINT ===
       # This section converts HTML documents to PDF using Weasyprint.
       # Downstream projects: Add any additional Weasyprint PDF generation steps here.
@@ -671,6 +716,20 @@ jobs:
           docs/tracematrix/tracematrix.html
           "docs/TemplateDotNetTool Trace Matrix.pdf"
 
+      - name: Generate Review Plan PDF with Weasyprint
+        run: >
+          dotnet weasyprint
+          --pdf-variant pdf/a-3u
+          docs/reviewplan/review-plan.html
+          "docs/TemplateDotNetTool Review Plan.pdf"
+
+      - name: Generate Review Report PDF with Weasyprint
+        run: >
+          dotnet weasyprint
+          --pdf-variant pdf/a-3u
+          docs/reviewreport/review-report.html
+          "docs/TemplateDotNetTool Review Report.pdf"
+
       # === UPLOAD ARTIFACTS ===
       # This section uploads all generated documentation artifacts.
       # Downstream projects: Add any additional artifact uploads here.

.reviewmark.yaml

@@ -0,0 +1,38 @@
+---
+# ReviewMark Configuration File
+# This file defines which files require review, where the evidence store is located,
+# and how files are grouped into named review-sets.
+
+# Patterns identifying all files that require review.
+# Processed in order; prefix a pattern with '!' to exclude.
+needs-review:
+  - "**/*.cs"
+  - "!**/obj/**"
+
+# Evidence source: review data and index.json are located in the 'reviews' branch
+# of this repository, accessed through the GitHub public HTTPS raw content access.
+# Note: The 'reviews' branch must be created and populated with review evidence PDFs
+# and an index.json before enforcement (--enforce flag) can be enabled in the pipeline.
+evidence-source:
+  type: url
+  location: https://raw.githubusercontent.com/demaconsulting/TemplateDotNetTool/reviews/index.json
+
+# Review sets grouping files by logical unit of review.
+reviews:
+  - id: TemplateTool-CLI-Review
+    title: Review of Template DotNet Tool CLI
+    paths:
+      - "src/**/Program.cs"
+      - "src/**/Context.cs"
+
+  - id: TemplateTool-Utilities-Review
+    title: Review of Template DotNet Tool Utilities
+    paths:
+      - "src/**/PathHelpers.cs"
+      - "src/**/Validation.cs"
+
+  - id: TemplateTool-Tests-Review
+    title: Review of Template DotNet Tool Tests
+    paths:
+      - "test/**/*.cs"
+      - "!**/obj/**"

docs/reviewplan/definition.yaml

@@ -0,0 +1,11 @@
+---
+resource-path:
+  - docs/reviewplan
+  - docs/template
+input-files:
+  - docs/reviewplan/title.txt
+  - docs/reviewplan/introduction.md
+  - docs/reviewplan/review-plan.md
+template: template.html
+table-of-contents: true
+number-sections: true

docs/reviewplan/introduction.md

@@ -0,0 +1,32 @@
+# Introduction
+
+This document contains the review plan for the Template DotNet Tool project.
+
+## Purpose
+
+This review plan provides a comprehensive overview of all files requiring formal review
+in the Template DotNet Tool project. It identifies which review-sets cover which
+files and serves as evidence that every file requiring review is covered by at least
+one named review-set.
+
+## Scope
+
+This review plan covers:
+
+- C# source code files requiring formal review
+- Mapping of C# source files to named review-sets
+
+## Generation Source
+
+This report is automatically generated by the ReviewMark tool, analyzing the
+`.reviewmark.yaml` configuration and the review evidence store. It serves as evidence
+that every file requiring review is covered by a current, valid review.
+
+## Audience
+
+This document is intended for:
+
+- Software developers working on Template DotNet Tool
+- Quality assurance teams validating review coverage
+- Project stakeholders reviewing compliance status
+- Auditors verifying that all required files have been reviewed

docs/reviewplan/title.txt

@@ -0,0 +1,13 @@
+---
+title: Template DotNet Tool Review Plan
+subtitle: File Review Plan for the Template DotNet Tool
+author: DEMA Consulting
+description: File Review Plan for the Template DotNet Tool
+lang: en-US
+keywords:
+  - Template DotNet Tool
+  - Review Plan
+  - File Reviews
+  - .NET
+  - Tool
+---

docs/reviewreport/definition.yaml

@@ -0,0 +1,11 @@
+---
+resource-path:
+  - docs/reviewreport
+  - docs/template
+input-files:
+  - docs/reviewreport/title.txt
+  - docs/reviewreport/introduction.md
+  - docs/reviewreport/review-report.md
+template: template.html
+table-of-contents: true
+number-sections: true

docs/reviewreport/introduction.md

@@ -0,0 +1,33 @@
+# Introduction
+
+This document contains the review report for the Template DotNet Tool project.
+
+## Purpose
+
+This review report provides evidence that each review-set is current — the review
+evidence matches the current file fingerprints. It confirms that all formal reviews
+conducted for Template DotNet Tool remain valid for the current state of the
+reviewed files.
+
+## Scope
+
+This review report covers:
+
+- Current review-set status (current, stale, or missing)
+- File fingerprints and review evidence matching
+- Review coverage verification
+
+## Generation Source
+
+This report is automatically generated by the ReviewMark tool, comparing the current
+file fingerprints against the review evidence store. It serves as evidence that all
+review-sets are current and no reviewed file has changed since its review was conducted.
+
+## Audience
+
+This document is intended for:
+
+- Software developers working on Template DotNet Tool
+- Quality assurance teams validating review currency
+- Project stakeholders reviewing compliance status
+- Auditors verifying that all reviews remain valid for the current release

docs/reviewreport/title.txt

@@ -0,0 +1,13 @@
+---
+title: Template DotNet Tool Review Report
+subtitle: File Review Report for the Template DotNet Tool
+author: DEMA Consulting
+description: File Review Report for the Template DotNet Tool
+lang: en-US
+keywords:
+  - Template DotNet Tool
+  - Review Report
+  - File Reviews
+  - .NET
+  - Tool
+---

requirements.yaml

@@ -271,3 +271,15 @@ sections:
               - SonarMark_IssuesRetrieval
               - SonarMark_HotSpotsRetrieval
               - SonarMark_MarkdownReportGeneration
+
+          - id: Template-OTS-ReviewMark
+            title: ReviewMark shall generate a review plan and review report from the review configuration.
+            justification: |
+              DemaConsulting.ReviewMark reads the .reviewmark.yaml configuration and the review
+              evidence store to produce a review plan and review report documenting file review
+              coverage and currency. It runs in the same CI pipeline that produces the TRX test
+              results, so a successful pipeline run is evidence that ReviewMark executed without error.
+            tags: [ots]
+            tests:
+              - ReviewMark_ReviewPlanGeneration
+              - ReviewMark_ReviewReportGeneration