Add BuildMark build notes generation

[Copilot]

Pull Request

Description

Integrates DemaConsulting.BuildMark tool to generate automated build notes from Git repository history and GitHub issues. Build notes are generated during CI, published as PDF artifact, and used as GitHub release body instead of auto-generated release notes.

Changes

• Added BuildMark tool (v0.2.0) to .config/dotnet-tools.json
• Created build notes template in docs/buildnotes/:
  • definition.yaml: Pandoc configuration for document generation
  • introduction.md: Static content describing build notes purpose and scope
  • title.txt: Document metadata (title, author, keywords)
• Updated build workflow (.github/workflows/build.yaml):
  • Added BuildMark step to generate docs/buildnotes.md from repository history
  • Added Pandoc/Weasyprint steps to produce "ReqStream Build Notes.pdf"
  • Included buildnotes.md in documentation artifacts
• Updated release workflow (.github/workflows/release.yaml):
  • Extract buildnotes.md from artifacts to repository root
  • Configure ncipollo/release-action to use buildnotes.md as release body
  • Disabled automatic release notes generation

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

Issue linking handled automatically by system.

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

BuildMark tool requires GH_TOKEN environment variable for GitHub API access, which is provided in the workflow. The implementation follows the pattern established in the BuildMark repository itself.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Feature]: Add BuildMark Build Notes</issue_title>
<issue_description>### Problem Statement

The ReqStream project should publish detailed build notes using DemaConsulting.BuildMark

Proposed Solution

The https://github.com/demaconsulting/BuildMark project demonstrates an approach to adding detailed build notes. Specifically:

• Add the DemaConsulting.BuildMark dotnet tool version 0.2.0 to the project
• Add the docs/buildnotes document template folder
• Run the buildmark tool in the build-docs job to create the "docs/buildnotes.md" file (included in artifacts)
• Run the pandoc/weasyprint builds in build-docs to create the "docs/ReqStream Build Notes.pdf" (included in artifacts)
• Modify the release.yaml file to:
  • Move the buildnotes.md file up to the top of the repo (out of the artifacts folder)
  • Modify ncipollo/release-action to use buildnotes.md as the bodyFile

Alternatives Considered

No response

Usage Examples

Benefits

The BuildMark tool is used for GitHub build notes, and the build notes are also available in PDF form.

Priority

High - Blocking my use case

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 BuildMark Build Notes #98

---

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