Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Oct 7, 2025

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:

  • Introduced a $failedCommands collection to track commands that fail documentation generation, capturing their names and error details.
  • After processing all commands, if any failures occurred, the script outputs a detailed summary to the console and to the $env:GITHUB_STEP_SUMMARY file, including a markdown table of failed commands and their errors, and then fails the build with an appropriate exit code.

Copilot AI review requested due to automatic review settings October 7, 2025 06:43
@MariusStorhaug MariusStorhaug self-assigned this Oct 7, 2025
Copy link
Contributor

Copilot AI left a 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.

Copilot AI review requested due to automatic review settings October 7, 2025 07:44
Copy link
Contributor

Copilot AI left a 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.

Copilot AI review requested due to automatic review settings October 7, 2025 08:12
Copy link
Contributor

Copilot AI left a 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.

@MariusStorhaug MariusStorhaug enabled auto-merge (squash) October 7, 2025 08:16
@MariusStorhaug MariusStorhaug merged commit adc0da7 into main Oct 7, 2025
18 checks passed
@MariusStorhaug MariusStorhaug deleted the improveDocsError branch October 7, 2025 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants