Improve Console report format documentation with examples, screenshots, and automated regeneration scripts

[Copilot]

Enhanced the Console report format documentation by adding comprehensive examples with visual outputs showing the different configuration options available in ConsoleIssueReportFormatSettings, along with automated scripts to regenerate the screenshots when the addin is updated.

What's Changed

The documentation now includes four distinct examples with screenshots demonstrating:

1. Default Settings

Shows individual diagnostics for each issue with detailed file context and syntax highlighting.

2. Grouped by Rule (GroupByRule: true)

Groups issues with the same rule ID together, reducing redundancy and improving readability when multiple instances of the same issue exist.

3. With Summary Tables (ShowProviderSummary: true, ShowPrioritySummary: true)

Includes visual bar charts and detailed tables showing issue counts by provider and priority levels.

4. Combined Features

Demonstrates the most comprehensive output combining grouped diagnostics with summary tables.

Automated Screenshot Generation Pipeline

Added a complete automation pipeline in docs/input/assets/scripts/console-examples/ to enable regenerating screenshots when the addin is updated:

• Four Cake scripts corresponding to each documented scenario (default, grouped, summaries, combined)
• Automated screenshot generation using generate-screenshot.sh that converts ANSI-colored console output to high-quality PNG images
• Complete workflow using ansi2html and wkhtmltoimage for terminal-to-image conversion
• Sample issue data that produces realistic console outputs similar to real projects
• Configuration files for running the scripts with proper NuGet package sources
• Master script (run-examples.sh) to execute all examples and generate all screenshots with one command
• Comprehensive README with usage instructions and documentation

Benefits

• Visual Learning: Users can now see exactly how each setting affects the console output
• Better Decision Making: Clear visual comparison helps users choose the right configuration for their needs
• Comprehensive Coverage: All major ConsoleIssueReportFormatSettings options are demonstrated
• Multi-Platform Support: Each example includes code snippets for Cake .NET Tool, Cake SDK, and Cake Frosting
• Maintainability: Screenshots can be easily regenerated when the addin functionality changes using ./run-examples.sh
• Automated Pipeline: Complete workflow from console output to final PNG images ready for documentation

The enhanced documentation makes it much easier for users to understand and utilize the various formatting options available in the Console report format addin.

Fixes #978.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[pascalberger]

@copilot Also commit scripts / tests used for generating the screenshots, so that they can be regenerated if the addin is updated.

[Copilot]

@copilot Also commit scripts / tests used for generating the screenshots, so that they can be regenerated if the addin is updated.

I've added console report example scripts for regenerating screenshots. The scripts are located in docs/input/assets/scripts/console-examples/ and include:

• Four Cake scripts for each documented scenario (default, grouped, summaries, combined)
• Sample issue data that produces realistic console outputs
• Configuration files for running the scripts
• A README with usage instructions
• A helper script to run all examples

These scripts can be used to regenerate the screenshots when the addin is updated. Commit: 8a741b5

[pascalberger]

@copilot The scripts should generate and update the screenshots in the docs directory

[Copilot]

@copilot The scripts should generate and update the screenshots in the docs directory

I've updated the scripts to automatically generate and update the screenshots in the docs directory. The scripts now include:

• generate-screenshot.sh - Converts console output to PNG images using ansi2html and wkhtmltoimage
• Updated run-examples.sh - Generates all screenshots at once
• Complete automation pipeline that captures ANSI-colored console output and converts it to high-quality PNG files
• Screenshots are automatically saved to docs/input/assets/images/console-examples/

Users can now regenerate all screenshots with a single command: ./run-examples.sh

Commit: 2ade8af

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

• 224.0.0.251
• esm.ubuntu.com
  • Triggering command: /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)