Add code quality report generation to build pipeline

[Copilot]

Pull Request

Description

Integrates SonarMark 1.0.0 into the build pipeline to generate a "TestResults Code Quality.pdf" report from SonarCloud analysis results, published alongside existing documentation artifacts.

Changes:

• Tool manifest (.config/dotnet-tools.json): Added demaconsulting.sonarmark 1.0.0
• Spell check dictionary (.cspell.json): Added "hotspots" and "sonarmark" to dictionary
• Documentation template (docs/quality/): Created title metadata, introduction, and Pandoc definition matching existing doc structure
  • Introduction focuses on the document serving as evidence of good code quality standards
• Build workflow (.github/workflows/build.yaml): Added three steps in build-docs job:
  1. Query SonarCloud and generate markdown with SonarMark
  2. Convert to HTML with Pandoc
  3. Convert to PDF with Weasyprint

Report generation follows the same pattern as requirements and trace matrix documents, using the existing template and tools.

Type of Change

• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

• Code builds successfully: dotnet build --configuration Release
• All tests pass: dotnet test --configuration Release
• Code produces zero warnings

Code Quality

• Code formatting is correct: dotnet format --verify-no-changes
• New code has appropriate XML documentation comments
• Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

• Spell checker passes: cspell "**/*.{md,cs}"
• Markdown linter passes: markdownlint "**/*.md"
• YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

• Added unit tests for new functionality
• Updated existing tests if behavior changed
• All tests follow the AAA (Arrange, Act, Assert) pattern
• Test coverage is maintained or improved

Documentation

• Updated README.md (if applicable)
• Updated ARCHITECTURE.md (if applicable)
• Added code examples for new features (if applicable)
• Updated requirements.yaml (if applicable)

Additional Notes

The SonarMark tool queries the existing SonarCloud analysis already performed during the build. No additional analysis overhead is introduced. The SONAR_TOKEN secret is already configured and reused from the existing SonarScanner integration.

The code quality report introduction has been designed to be tool-agnostic, serving as evidence of code quality standards rather than focusing on specific analysis tools, allowing for future expansion beyond SonarCloud.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Feature]: Add Code Quality Report</issue_title>
<issue_description>### Problem Statement

The build pipeline needs to build a code-quality report with Sonar analysis results

Proposed Solution

A new "TestResults Code Quality.pdf" needs to be generated using the same pandoc/weasyprint approach as is used for requirements.

This involves:

• Adding DemaConsulting.SonarMark 1.0.0 to the .config/dotnet-tools.json file.
• Creating a docs/quality/ template folder similar to https://github.com/demaconsulting/SonarMark/tree/main/docs/quality but updated for the TestResults project.
• Update the build.yaml workflow so the build-docs job runs SonarMark to generate the docs/quality/sonar-quality.md report and then build the "docs/ TestResults Code Quality.pdf" file - see https://github.com/demaconsulting/SonarMark/blob/main/.github/workflows/build.yaml for reference.

Alternatives Considered

No response

Usage Examples

Benefits

Report of code quality included with releases.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

• I have searched existing issues to ensure this is not a duplicate
• I have provided a clear description of the feature
• I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes [Feature]: Add Code Quality Report #76

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Malcolmnixon]

Please run the quality checks - issues are still being introduced - for example docs/quality/introduction.md:17:12 Unknown word (hotspots)

[Malcolmnixon]

This quality report will end up growing to contain more than just SonarCloud analysis - don't try to describe the tool, just describe that the purpose of the document is to act as evidence of good code quality.

[Copilot]

Updated Purpose section to focus on the document serving as evidence of good quality standards rather than describing SonarCloud specifically. (d7efc48)

[Copilot]

Please run the quality checks - issues are still being introduced - for example docs/quality/introduction.md:17:12 Unknown word (hotspots)

Added "hotspots" and "sonarmark" to .cspell.json dictionary. All spell checks now pass. (d7efc48)