Skip to content

v1.0.9

Choose a tag to compare

@github-actions github-actions released this 12 Oct 17:59
· 4 commits to main since this release
da2a725

🩹 [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.yml workflow now separates artifact upload into its own UploadArtifact job, and introduces two test jobs: ActionTestDefault (without always showing summary) and ActionTestWithSummary (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.yml file reorders the inputs section for clarity, and environment variables passed to scripts now use a consistent DOCUMENT_PSMODULE_INPUT_* naming scheme instead of the previous GITHUB_ACTION_INPUT_*. [1] [2]
  • The scripts/main.ps1 script now accepts Name and ShowSummaryOnSuccess as 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.ps1 script 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]