Add BuildMark build notes generation

.config/dotnet-tools.json

@@ -49,6 +49,12 @@
       "commands": [
         "reqstream"
       ]
+    },
+    "demaconsulting.buildmark": {
+      "version": "0.2.0",
+      "commands": [
+        "buildmark"
+      ]
     }
   }
 }

.github/workflows/build.yaml

@@ -389,8 +389,44 @@ jobs:
           docs/quality/quality.html
           "docs/SpdxModel Code Quality.pdf"
 
+      - name: Generate Build Notes with BuildMark
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: >
+          dotnet 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
+          docs/buildnotes/title.txt
+          --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: Generate Build Notes PDF with Weasyprint
+        run: >
+          dotnet weasyprint
+          --pdf-variant pdf/a-3u
+          docs/buildnotes/buildnotes.html
+          "docs/SpdxModel Build Notes.pdf"
+
       - name: Upload Documentation
         uses: actions/upload-artifact@v6
         with:
           name: documentation
-          path: docs/*.pdf
+          path: |
+            docs/*.pdf
+            docs/buildnotes.md

.github/workflows/release.yaml

@@ -62,6 +62,11 @@ jobs:
           name: documentation
           path: artifacts
 
+      - name: Move buildnotes.md to root
+        run: |
+          set -e
+          mv artifacts/buildnotes.md buildnotes.md
+
       - name: Clean Artifacts
         shell: bash
         run: rm -rf artifacts/test
@@ -71,7 +76,8 @@ jobs:
         uses: ncipollo/release-action@v1
         with:
           artifacts: 'artifacts/**/*'
-          generateReleaseNotes: true
+          bodyFile: buildnotes.md
+          generateReleaseNotes: false
           tag: ${{ inputs.version }}
 
       - name: Publish to Nuget

.gitignore

@@ -25,10 +25,16 @@ coverage/
 node_modules/
 
 # Generated documentation
-docs/*.html
+docs/guide/*.html
+docs/requirements/*.html
+docs/tracematrix/*.html
+docs/justifications/*.html
+docs/quality/*.html
+docs/buildnotes/*.html
 docs/*.pdf
 docs/requirements/requirements.md
 docs/tracematrix/tracematrix.md
 docs/justifications/justifications.md
+docs/buildnotes.md
 *.err
 package-lock.json

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 SpdxModel project.
+
+## Purpose
+
+This report serves as a comprehensive record of changes and bug fixes for this
+release of SpdxModel. 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, analyzing the
+Git repository history and issue tracking information. It provides evidence of
+changes made to the SpdxModel library for SPDX SBOM manipulation.
+
+## Audience
+
+This document is intended for:
+
+- Software developers working on SpdxModel
+- Users evaluating what has changed in this release
+- Project stakeholders tracking progress
+- Contributors understanding recent changes

docs/buildnotes/title.txt

@@ -0,0 +1,16 @@
+---
+title: SpdxModel
+subtitle: Build Notes
+author: DEMA Consulting
+description: Build notes for the SpdxModel library for SPDX SBOM manipulation
+lang: en-US
+keywords:
+  - SpdxModel
+  - Build Notes
+  - Release Notes
+  - SPDX
+  - SBOM
+  - C#
+  - .NET
+  - Documentation
+---