Add build notes generation to build-docs workflow and fix BuildMark bugs

.github/workflows/build.yaml

@@ -255,6 +255,12 @@ jobs:
       - name: Restore Tools
         run: dotnet tool restore
 
+      - name: Download BuildMark Package
+        uses: actions/download-artifact@v7
+        with:
+          name: artifacts-windows-latest
+          path: packages
+
       - name: Setup Node.js
         uses: actions/setup-node@v6
         with:
@@ -308,13 +314,53 @@ jobs:
           echo "=== SonarCloud Quality Report ==="
           cat docs/quality/sonar-quality.md
 
+      - name: Install BuildMark Tool
+        shell: bash
+        run: |
+          echo "Installing BuildMark version ${{ inputs.version }}"
+          dotnet tool install --global \
+            --add-source packages \
+            --version ${{ inputs.version }} \
+            DemaConsulting.BuildMark
+
+      - name: Generate Build Notes with BuildMark
+        shell: bash
+        run: >
+          buildmark
+          --build-version ${{ inputs.version }}
+          --report docs/buildnotes.md
+          --report-depth 1
+
+      - name: Display Build Notes Report
+        shell: bash
+        run: |
+          echo "=== Build Notes Report ==="
+          cat docs/buildnotes.md
+
+      - name: Generate Build Notes HTML with Pandoc
+        shell: bash
+        run: >
+          dotnet pandoc
+          --defaults docs/buildnotes/definition.yaml
+          --metadata version="${{ inputs.version }}"
+          --metadata date="$(date +'%Y-%m-%d')"
+          --filter node_modules/.bin/mermaid-filter.cmd
+          --output docs/buildnotes/buildnotes.html
+
+      - name: Convert Build Notes HTML to PDF with Weasyprint
+        run: >
+          dotnet weasyprint
+          docs/buildnotes/buildnotes.html
+          "docs/BuildMark Build Notes.pdf"
+
       - 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')"
+          --filter node_modules/.bin/mermaid-filter.cmd
           --output docs/quality/quality.html
 
       - name: Convert Code Quality HTML to PDF with Weasyprint
@@ -327,4 +373,6 @@ jobs:
         uses: actions/upload-artifact@v6
         with:
           name: documents
-          path: docs/*.pdf
+          path: |
+            docs/*.pdf
+            docs/buildnotes.md

.gitignore

@@ -35,3 +35,5 @@ docs/tracematrix/*.html
 docs/quality/sonar-quality.md
 docs/quality/codeql-quality.md
 docs/quality/*.html
+docs/buildnotes.md
+docs/buildnotes/*.html

docs/buildnotes/definition.yaml

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

docs/buildnotes/introduction.md

@@ -0,0 +1,33 @@
+# Introduction
+
+This document contains the build notes for the BuildMark project.
+
+## Purpose
+
+This report serves as a comprehensive record of changes and bug fixes for this
+release of BuildMark. It provides transparency about what has changed since the
+previous version and helps users understand the improvements and fixes included
+in this build.
+
+## Scope
+
+This build notes report covers:
+
+- Version information and commit details
+- Changes and new features implemented
+- Bugs fixed in this release
+
+## Generation Source
+
+This report is automatically generated by the BuildMark tool itself, analyzing the
+Git repository history and issue tracking information. It serves as evidence that
+the BuildMark tool can successfully generate build notes for real-world projects.
+
+## Audience
+
+This document is intended for:
+
+- Software developers working on BuildMark
+- Users evaluating what has changed in this release
+- Project stakeholders tracking progress
+- Contributors understanding recent changes

docs/buildnotes/title.txt

@@ -0,0 +1,14 @@
+---
+title: BuildMark Tool
+subtitle: Build Notes
+author: DEMA Consulting
+description: Build notes for the BuildMark Tool for generating markdown build notes
+lang: en-US
+keywords:
+  - BuildMark
+  - Build Notes
+  - Release Notes
+  - C#
+  - .NET
+  - Documentation
+---