v1.0.9
🩹 [Patch]: Group successful and failed doc generation (#26)
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:
- The
.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:
- The
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] - The
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:
- The
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]