Add ReviewMark integration (review plan, review report, multi-set config)#69
Merged
Malcolmnixon merged 3 commits intomainfrom Mar 14, 2026
Merged
Conversation
…et config) Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update project with latest updates from template and formal reviews
Add ReviewMark integration (review plan, review report, multi-set config)
Mar 14, 2026
Malcolmnixon
requested changes
Mar 14, 2026
…to SarifMark-Integration-Review Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Malcolmnixon
approved these changes
Mar 14, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Integrates ReviewMark into SarifMark’s compliance/documentation pipeline to produce formal file review coverage and currency artifacts, aligning the repo with TemplateDotNetTool patterns.
Changes:
- Added ReviewMark tool installation, version tracking, and CI self-validation.
- Introduced
.reviewmark.yamlwith multiple review-sets and generated Review Plan / Review Report documentation inputs. - Linked ReviewMark execution to OTS requirements traceability via new
requirements.yamlentries and CI-generated artifacts.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
requirements.yaml |
Adds OTS requirement mapping ReviewMark execution to self-validation TRX evidence. |
docs/reviewplan/title.txt |
Adds Pandoc title metadata for the Review Plan document. |
docs/reviewplan/introduction.md |
Adds Review Plan introduction/boilerplate content. |
docs/reviewplan/definition.yaml |
Adds Pandoc defaults definition for generating Review Plan output. |
docs/reviewreport/title.txt |
Adds Pandoc title metadata for the Review Report document. |
docs/reviewreport/introduction.md |
Adds Review Report introduction/boilerplate content. |
docs/reviewreport/definition.yaml |
Adds Pandoc defaults definition for generating Review Report output. |
AGENTS.md |
Registers the Code Review Agent and routes “formal file review” tasks to it. |
.versionmark.yaml |
Adds ReviewMark capture and updates tool regexes to accept optional pre-release suffixes. |
.reviewmark.yaml |
Introduces ReviewMark configuration (needs-review patterns, evidence source, review-sets). |
.gitignore |
Ignores generated ReviewMark markdown outputs under docs/reviewplan/ and docs/reviewreport/. |
.github/workflows/build.yaml |
Adds ReviewMark validation plus review plan/report generation and PDF/HTML build steps. |
.github/agents/code-review-agent.md |
Adds agent instructions for conducting formal review-set reviews using ReviewMark. |
.cspell.json |
Adds ReviewMark-related terms to the spell-check dictionary. |
.config/dotnet-tools.json |
Adds demaconsulting.reviewmark as a restored dotnet tool. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This was referenced Apr 6, 2026
This was referenced Apr 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings SarifMark in line with TemplateDotNetTool PRs #58 and #59 by integrating ReviewMark for formal file review coverage and currency tracking.
ReviewMark configuration
.reviewmark.yaml— three review sets pairing source with tests:SarifMark-CLI-Review(Program.cs,Context.cs+ProgramTests.cs,ContextTests.cs),SarifMark-Core-Review(PathHelpers.cs,Validation.cs,SarifResult.cs,SarifResults.cs+PathHelpersTests.cs,SarifResultsTests.cs),SarifMark-Integration-Review(IntegrationTests.cs,Runner.cs,AssemblyInfo.cs).config/dotnet-tools.json— addsdemaconsulting.reviewmarkv0.1.0-rc.3.versionmark.yaml— addsreviewmarkentry; applies pre-release regex ((?:-[a-zA-Z0-9.]+)?) to all tool patterns.gitignore— excludes generatedreview-plan.mdandreview-report.mdReview plan / report documents
docs/reviewplan/,docs/reviewreport/— Pandoc definition, title, and introduction for each document.github/workflows/build.yaml— ReviewMark self-validation, plan and report generation (markdown → HTML → PDF) added tobuild-docsjob;reviewmarkadded to version captureAgent and requirements
.github/agents/code-review-agent.md— agent instructions for performing formal reviews against the review-set IDsAGENTS.md— addsCode Review Agententry andPerform a formal file review → Code Review Agentrouting rulerequirements.yaml—SarifMark-OTS-ReviewMarkOTS requirement linked toReviewMark_ReviewPlanGenerationandReviewMark_ReviewReportGenerationself-validation tests.cspell.json— addsreviewmark,ReviewMark,reviewplan,reviewreportType of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.SarifMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .dotnet run --project src/DemaConsulting.SarifMark --configuration Release --framework net10.0 --no-build -- --validateTesting
Documentation
Additional Notes
No source code changes — infrastructure and configuration only.
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.