-
Notifications
You must be signed in to change notification settings - Fork 0
🩹 [Patch]: Enhance error handling and summary reporting in documentation generation #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Enhances the PowerShell documentation build script to collect per-command failures, emit a structured GitHub Actions step summary, and fail the build when any command help generation fails.
- Adds aggregation of failed command metadata and detailed console/status output.
- Generates a markdown summary (including a table and overall success/failure counts) written to GITHUB_STEP_SUMMARY.
- Exits with non-zero status if any command documentation generation fails.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…in documentation generation
…trol summary display
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…ts in initializer and loader scripts
Description
This pull request enhances the error handling and reporting for PowerShell module documentation generation. Now, when documentation generation fails for one or more commands, the script collects detailed error information, summarizes the failures in a GitHub Actions step summary, and fails the build with a clear message.
Improvements to error handling and reporting:
$failedCommandscollection to track commands that fail documentation generation, capturing their names and error details.$env:GITHUB_STEP_SUMMARYfile, including a markdown table of failed commands and their errors, and then fails the build with an appropriate exit code.