🩹 [Patch]: Group successful and failed doc generation #26
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR addresses issue #229 by modifying the test workflow to verify that the step summary is empty when ShowSummaryOnSuccess is not explicitly enabled. The change removes the ShowSummaryOnSuccess: true parameter and adds a validation step to confirm the summary remains empty.
- Removed
ShowSummaryOnSuccess: trueparameter from the action configuration - Added a new validation step to check that
GITHUB_STEP_SUMMARYis empty
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.
Pull Request Overview
Copilot reviewed 1 out of 1 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.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…able handling in action scripts
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 4 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.
…ure status or success flag
… variable assignments
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 4 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.
Description
This pull request reorganizes the GitHub Actions workflow, improves input handling and environment variable usage in the action, and enhances the summary output for PowerShell module documentation commands. The most notable changes are the restructuring of workflow jobs to support different summary behaviors, improved input/environment variable consistency, and more detailed step summaries.
GitHub Actions workflow improvements:
.github/workflows/Action-Test.ymlworkflow now separates artifact upload into its ownUploadArtifactjob, and introduces two test jobs:ActionTestDefault(without always showing summary) andActionTestWithSummary(always shows summary on success). This allows testing both behaviors and ensures artifacts are available before running tests. [1] [2] [3]Action input and environment variable handling:
action.ymlfile reorders theinputssection for clarity, and environment variables passed to scripts now use a consistentDOCUMENT_PSMODULE_INPUT_*naming scheme instead of the previousGITHUB_ACTION_INPUT_*. [1] [2]scripts/main.ps1script now acceptsNameandShowSummaryOnSuccessas parameters, defaulting to the new environment variable names, and updates how these values are handled and passed to helper scripts. [1] [2] [3]Summary output enhancements:
Build-PSModuleDocumentation.ps1script changes the summary section to use collapsible<details>blocks for failed and succeeded commands, making the output clearer and easier to navigate in GitHub step summaries. [1] [2]