[Feature]: Add BuildMark Build Notes #98
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