Add BuildMark build notes generation

[Copilot]

Pull Request

Description

Implements automated build notes generation using BuildMark, following the pattern established in ReqStream. BuildMark analyzes Git history and GitHub issues to generate structured release notes, with full HTML and PDF documentation generation.

Changes:

• .config/dotnet-tools.json: Added BuildMark v0.2.0
• docs/buildnotes/: Created documentation structure with title, introduction, and Pandoc configuration
• .github/workflows/build.yaml:
  • Added BuildMark generation step to build-docs job
  • Changed Display step to use shell: bash with cat for consistency
  • Added Pandoc HTML generation step for build notes with title.txt, version metadata, and date metadata (matching all other document generation steps)
  • Added Weasyprint PDF generation step for build notes
  • Uploads buildnotes.md and PDF artifact
• .github/workflows/release.yaml: Uses buildnotes.md as release body instead of GitHub's auto-generated notes
• .gitignore: Added comprehensive patterns for all generated documentation files:
  • Generated markdown: docs/buildnotes.md (plus existing patterns for requirements, tracematrix, justifications)
  • Generated HTML files in all subdirectories: docs/guide/*.html, docs/requirements/*.html, docs/tracematrix/*.html, docs/justifications/*.html, docs/quality/*.html, docs/buildnotes/*.html
  • Generated PDFs: docs/*.pdf

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• 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

No changes to application code—workflow and documentation configuration only. The implementation includes the complete documentation generation pipeline (Markdown → HTML → PDF) with full consistency to existing documentation patterns. The Pandoc invocation includes title.txt, version metadata, and date metadata matching all other document generation steps (User Guide, Requirements, Trace Matrix, Justifications, Quality). All generated documentation artifacts (HTML, PDF, and generated markdown files) are properly added to .gitignore following the ReqStream pattern, ensuring all temporary HTML files in subdirectories are excluded from version control.

Original prompt

Please implement BuildMark build notes as demonstrated in https://github.com/demaconsulting/ReqStream. Specifically follow it as a template and make sure to:

• Add the DemaConsulting.BuildMark tool to dotnet-tools.json
• Add the docs/buildnotes folder
• Update the build-docs job to generate the build notes
• Update the release.yaml to use the buildnotes.md as the release body file.

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[Malcolmnixon]

Where's the metadata lines - take a look at the other pandoc invocations when building documents.

[Copilot]

Added in commit dc90c63:

• docs/buildnotes/title.txt as first argument
• --metadata version="${{ inputs.version }}"
• --metadata date="$(date +'%Y-%m-%d')"

Now matches the pattern used in all other Pandoc invocations (User Guide, Requirements, Trace Matrix, Justifications, Quality).

[Malcolmnixon]

What about the other temporary HTML files?

[Copilot]

Added in commit f82521a. Now includes gitignore patterns for all generated HTML files:

• docs/guide/*.html
• docs/requirements/*.html
• docs/tracematrix/*.html
• docs/justifications/*.html
• docs/quality/*.html
• docs/buildnotes/*.html

Matches the pattern used in ReqStream.