Add requirements justifications and upgrade to ReqStream 1.1.0

.config/dotnet-tools.json

@@ -33,7 +33,7 @@
       ]
     },
     "demaconsulting.reqstream": {
-      "version": "1.0.1",
+      "version": "1.1.0",
       "commands": [
         "reqstream"
       ]

.github/workflows/build.yaml

@@ -313,6 +313,7 @@ jobs:
           --tests "test-results/**/*.trx"
           --report docs/requirements/requirements.md
           --matrix docs/tracematrix/tracematrix.md
+          --justifications docs/justifications/justifications.md
           --enforce
 
       - name: Generate CodeQL Quality Report with SarifMark
@@ -427,6 +428,22 @@ jobs:
           docs/tracematrix/tracematrix.html
           "docs/BuildMark Trace Matrix.pdf"
 
+      - name: Generate Requirements Justifications HTML with Pandoc
+        shell: bash
+        run: >
+          dotnet pandoc
+          --defaults docs/justifications/definition.yaml
+          --metadata version="${{ inputs.version }}"
+          --metadata date="$(date +'%Y-%m-%d')"
+          --filter node_modules/.bin/mermaid-filter.cmd
+          --output docs/justifications/justifications.html
+
+      - name: Convert Requirements Justifications HTML to PDF with Weasyprint
+        run: >
+          dotnet weasyprint
+          docs/justifications/justifications.html
+          "docs/BuildMark Requirements Justifications.pdf"
+
       - name: Generate Code Quality HTML with Pandoc
         shell: bash
         run: >

.gitignore

@@ -32,6 +32,8 @@ docs/requirements/requirements.md
 docs/requirements/*.html
 docs/tracematrix/tracematrix.md
 docs/tracematrix/*.html
+docs/justifications/justifications.md
+docs/justifications/*.html
 docs/quality/sonar-quality.md
 docs/quality/codeql-quality.md
 docs/quality/*.html

docs/justifications/definition.yaml

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

docs/justifications/introduction.md

@@ -0,0 +1,29 @@
+# Introduction
+
+This document contains the justifications for the requirements of the BuildMark project.
+
+## Purpose
+
+BuildMark is a .NET command-line tool that generates comprehensive markdown build notes reports from
+Git repository history and GitHub issues. It analyzes commits, pull requests, and issues to create
+human-readable build notes, making it easy to integrate release documentation into CI/CD pipelines
+and documentation workflows.
+
+## Scope
+
+This justifications document provides the rationale and reasoning behind each requirement in the
+BuildMark requirements specification. Each requirement justification explains:
+
+- Why the requirement exists
+- The value it provides to users and stakeholders
+- How it contributes to the overall purpose of BuildMark
+
+## Audience
+
+This document is intended for:
+
+- Software developers working on BuildMark
+- Quality assurance teams validating requirements
+- Project stakeholders reviewing project scope
+- Auditors and compliance reviewers
+- Users understanding the tool's design decisions

docs/justifications/title.txt

@@ -0,0 +1,18 @@
+---
+title: BuildMark Requirements Justifications
+subtitle: Requirements Justifications for the BuildMark Tool
+author: DEMA Consulting
+description: Requirements Justifications for the BuildMark Tool
+lang: en-US
+keywords:
+  - BuildMark
+  - Requirements
+  - Justifications
+  - Specification
+  - .NET
+  - YAML
+  - Command-Line Tool
+  - Git
+  - GitHub
+  - Markdown
+---