Add --include-known-issues command-line option

[Copilot]

Pull Request

Description

Adds --include-known-issues flag to control known issues section visibility in markdown build reports. The underlying ToMarkdown() method already supported this via includeKnownIssues parameter, but it was inaccessible from the CLI.

Implementation

• Context.cs: Added IncludeKnownIssues property and argument parser case for --include-known-issues
• Program.cs: Updated help text and passed flag value to ToMarkdown(headingDepth, includeKnownIssues)
• Tests: Added unit and integration tests verifying flag parsing and property propagation

Usage

# Generate report with known issues section
buildmark --report build-notes.md --include-known-issues

# Default behavior unchanged (no known issues)
buildmark --report build-notes.md

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

Related to feature request for command-line control of known issues reporting.

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

Backward compatible - defaults to false maintaining current behavior. CodeQL security scan found no vulnerabilities.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Feature]: Known Issues Command-Line Option</issue_title>
<issue_description>### Problem Statement

There is no command-line option to enable known issues in markdown reports.

Proposed Solution

Add a command-line option to enable known-issues in build notes.

Alternatives Considered

No response

Usage Examples

Benefits

Control of known issues reporting for appropriate projects.

Priority

Medium - Would improve my workflow

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]: Known Issues Command-Line Option #37

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.