From c23bec19815512bf6a65758d36ae1c5058d0562f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 3 Feb 2026 15:59:19 +0000 Subject: [PATCH 1/3] Initial plan From f1b7d1c124d95abe1ad604bf1694ab8c7ae288f1 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 3 Feb 2026 16:02:41 +0000 Subject: [PATCH 2/3] Add Sonar analysis and documentation build infrastructure - Copy package.json from VHDLTest template - Copy .config/dotnet-tools.json with required tools - Copy docs/template/template.html for PDF generation - Copy and adapt docs/quality files for BuildMark - Add Sonar scanner steps to build job - Add build-docs job to build.yaml workflow Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --- .config/dotnet-tools.json | 54 ++++++ .github/workflows/build.yaml | 124 ++++++++++++ docs/quality/definition.yaml | 16 ++ docs/quality/introduction.md | 35 ++++ docs/quality/title.txt | 17 ++ docs/template/template.html | 354 +++++++++++++++++++++++++++++++++++ package.json | 7 + 7 files changed, 607 insertions(+) create mode 100644 .config/dotnet-tools.json create mode 100644 docs/quality/definition.yaml create mode 100644 docs/quality/introduction.md create mode 100644 docs/quality/title.txt create mode 100644 docs/template/template.html create mode 100644 package.json diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 0000000..8ac7fa7 --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,54 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "dotnet-sonarscanner": { + "version": "11.1.0", + "commands": [ + "dotnet-sonarscanner" + ] + }, + "microsoft.sbom.dotnettool": { + "version": "4.1.5", + "commands": [ + "sbom-tool" + ] + }, + "demaconsulting.spdxtool": { + "version": "2.6.0", + "commands": [ + "spdx-tool" + ] + }, + "demaconsulting.pandoctool": { + "version": "3.8.3", + "commands": [ + "pandoc" + ] + }, + "demaconsulting.weasyprinttool": { + "version": "68.0.0", + "commands": [ + "weasyprint" + ] + }, + "demaconsulting.reqstream": { + "version": "1.0.1", + "commands": [ + "reqstream" + ] + }, + "demaconsulting.sonarmark": { + "version": "1.1.0", + "commands": [ + "sonarmark" + ] + }, + "demaconsulting.sarifmark": { + "version": "1.1.0", + "commands": [ + "sarifmark" + ] + } + } +} \ No newline at end of file diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index fc5f08a..8546f73 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -62,10 +62,27 @@ jobs: 9.x 10.x + - name: Restore Tools + run: > + dotnet tool restore + - name: Restore Dependencies run: > dotnet restore + - name: Start Sonar Scanner + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: > + dotnet dotnet-sonarscanner + begin + /k:"demaconsulting_BuildMark" + /o:"demaconsulting" + /d:sonar.token="${{ secrets.SONAR_TOKEN }}" + /d:sonar.host.url="https://sonarcloud.io" + /d:sonar.cs.opencover.reportsPaths=**/*.opencover.xml + /d:sonar.scanner.scanAll=false + - name: Build run: > dotnet build @@ -83,6 +100,14 @@ jobs: --logger "trx;LogFilePrefix=${{ matrix.os }}" --results-directory test-results + - name: End Sonar Scanner + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: > + dotnet dotnet-sonarscanner + end + /d:sonar.token="${{ secrets.SONAR_TOKEN }}" + - name: Create Dotnet Tool run: > dotnet pack @@ -134,6 +159,10 @@ jobs: 9.x 10.x + - name: Restore Tools + run: > + dotnet tool restore + - name: Restore Dependencies run: > dotnet restore @@ -204,3 +233,98 @@ jobs: echo "Testing buildmark --help..." buildmark --help || { echo "✗ Help command failed"; exit 1; } echo "✓ Help command succeeded" + + build-docs: + name: Build Documents + runs-on: windows-latest + + needs: [build, integration-test, codeql] + + permissions: + contents: read + + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Setup dotnet + uses: actions/setup-dotnet@v5 + with: + dotnet-version: '10.x' + + - name: Restore Tools + run: dotnet tool restore + + - name: Setup Node.js + uses: actions/setup-node@v6 + with: + node-version: 'lts/*' + + - name: Install npm dependencies + run: npm install + + - name: Download All Test Results + uses: actions/download-artifact@v7 + with: + pattern: test-results-* + path: test-results + merge-multiple: true + + - name: Download CodeQL SARIF + uses: actions/download-artifact@v7 + with: + name: codeql-sarif + path: codeql-results + + - name: Generate CodeQL Quality Report with SarifMark + run: > + dotnet sarifmark + --sarif codeql-results/csharp.sarif + --report docs/quality/codeql-quality.md + --heading "BuildMark CodeQL Analysis" + --report-depth 1 + + - name: Display CodeQL Quality Report + shell: bash + run: | + echo "=== CodeQL Quality Report ===" + cat docs/quality/codeql-quality.md + + - name: Generate Code Quality Report with SonarMark + env: + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} + run: > + dotnet sonarmark + --server https://sonarcloud.io + --project-key demaconsulting_BuildMark + --branch ${{ github.ref_name }} + --token "$env:SONAR_TOKEN" + --report docs/quality/sonar-quality.md + --report-depth 1 + + - name: Display SonarCloud Quality Report + shell: bash + run: | + echo "=== SonarCloud Quality Report ===" + cat docs/quality/sonar-quality.md + + - name: Generate Code Quality HTML with Pandoc + shell: bash + run: > + dotnet pandoc + --defaults docs/quality/definition.yaml + --metadata version="${{ inputs.version }}" + --metadata date="$(date +'%Y-%m-%d')" + --output docs/quality/quality.html + + - name: Convert Code Quality HTML to PDF with Weasyprint + run: > + dotnet weasyprint + docs/quality/quality.html + "docs/BuildMark Code Quality.pdf" + + - name: Upload Document Artifacts + uses: actions/upload-artifact@v6 + with: + name: documents + path: docs/*.pdf diff --git a/docs/quality/definition.yaml b/docs/quality/definition.yaml new file mode 100644 index 0000000..65420a4 --- /dev/null +++ b/docs/quality/definition.yaml @@ -0,0 +1,16 @@ +--- +resource-path: + - docs/quality + - docs/template + +input-files: + - docs/quality/title.txt + - docs/quality/introduction.md + - docs/quality/codeql-quality.md + - docs/quality/sonar-quality.md + +template: template.html + +table-of-contents: true + +number-sections: true diff --git a/docs/quality/introduction.md b/docs/quality/introduction.md new file mode 100644 index 0000000..e2f2996 --- /dev/null +++ b/docs/quality/introduction.md @@ -0,0 +1,35 @@ +# Introduction + +This document contains the code quality analysis report for the BuildMark project. + +## Purpose + +This report serves as evidence that the BuildMark codebase maintains good quality +standards. It provides a comprehensive analysis of code quality metrics, including +quality gate status, code issues, security hot spots, technical debt, and code coverage. + +## Scope + +This code quality report covers: + +- Quality gate status and conditions +- Code issues categorized by type and severity +- Security hot spots requiring review +- Technical debt assessment +- Code coverage and duplication metrics + +## Analysis Source + +This report contains quality analysis results captured at the time this version of BuildMark +was built. It serves as evidence that the code maintains good quality standards and provides +transparency about the project's code health. The analysis includes results from various +quality tools run during the build process. + +## Audience + +This document is intended for: + +- Software developers working on BuildMark +- Quality assurance teams reviewing code quality +- Project stakeholders evaluating project health +- Contributors understanding quality standards diff --git a/docs/quality/title.txt b/docs/quality/title.txt new file mode 100644 index 0000000..f55967c --- /dev/null +++ b/docs/quality/title.txt @@ -0,0 +1,17 @@ +--- +title: BuildMark Tool +subtitle: Code Quality Report +author: DEMA Consulting +description: Code Quality Report for the BuildMark Tool for generating markdown build notes +lang: en-US +keywords: + - BuildMark + - Code Quality + - SonarCloud + - CodeQL + - Analysis + - C# + - .NET + - Build Notes + - Documentation +--- diff --git a/docs/template/template.html b/docs/template/template.html new file mode 100644 index 0000000..eb2ac3a --- /dev/null +++ b/docs/template/template.html @@ -0,0 +1,354 @@ + + + + + + +$if(author-meta)$ + +$endif$ +$if(date-meta)$ + +$endif$ +$if(keywords)$ + +$endif$ +$if(description-meta)$ + +$endif$ + $if(title-prefix)$$title-prefix$ – $endif$$pagetitle$ + +$for(css)$ + +$endfor$ +$if(math)$ + $math$ +$endif$ +$for(header-includes)$ + $header-includes$ +$endfor$ + + +$for(include-before)$ +$include-before$ +$endfor$ +$if(title)$ +
+

$title$

+$if(subtitle)$ +

$subtitle$

+$endif$ +$if(version)$ +

Version $version$

+$endif$ +$for(author)$ +

$author$

+$endfor$ +$if(date)$ +

$date$

+$endif$ +
+$endif$ +$if(toc)$ + +$endif$ +$body$ +$for(include-after)$ +$include-after$ +$endfor$ + + diff --git a/package.json b/package.json new file mode 100644 index 0000000..ccccfb1 --- /dev/null +++ b/package.json @@ -0,0 +1,7 @@ +{ + "private": true, + "dependencies": { + "@mermaid-js/mermaid-cli": "11.12.0", + "mermaid-filter": "1.4.7" + } +} From e2dda703e3373287216810ba3196f865ccc081e6 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 3 Feb 2026 16:04:48 +0000 Subject: [PATCH 3/3] Fix branch parameter for SonarMark in build-docs job Use github.head_ref || github.ref_name to correctly handle both PR and branch events Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --- .github/workflows/build.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 8546f73..f6415a0 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -297,7 +297,7 @@ jobs: dotnet sonarmark --server https://sonarcloud.io --project-key demaconsulting_BuildMark - --branch ${{ github.ref_name }} + --branch ${{ github.head_ref || github.ref_name }} --token "$env:SONAR_TOKEN" --report docs/quality/sonar-quality.md --report-depth 1