Bump actions/checkout from 5 to 6 (#31)

Bumps actions/checkout from 5 to 6.

[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-d...

Bump super-linter/super-linter from 8.1.0 to 8.2.1 (#29)

Bumps super-linter/super-linter from 8.1.0 to 8.2.1.

🩹 [Patch]: Move documentation and link to Process-PSModule (#28)

Description

This pull request makes minor updates to the project metadata by simplifying the display names in both the README.md and action.yml files. The changes remove branding elements and redundant text for a cleaner presentation.

• Project naming:
  • Simplified the project name by removing redundant "(by PSModule)" from both the README.md and the action.yml files. [1] [2]
• Metadata cleanup:
  • Removed the branding section (icon and color) from action.yml for a more streamlined configuration.
• Documentation:
  • Shortened the project description in README.md by removing detailed usage instructions and focusing on the association with the PSModule framework.

🩹 [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.

• Fixes PSModule/Process-PSModule#229

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]

🩹 [Patch]: Encode all PowerShell files using UTF8 with BOM (#25)

Description

This pull request makes a minor update to the Planets.ps1 file. The change is not functionally significant but may address encoding or formatting.

• Added a byte order mark (BOM) at the start of Planets.ps1, which can help some editors recognize the file's encoding.

🪲[Fix]: Fix linting issue for main (#24)

This pull request updates the Action-Test GitHub Actions workflow to improve its automation and linting capabilities. The most important changes are grouped below.

Workflow triggers:

• The workflow will now also run on pushes to the main branch, in addition to the existing triggers (workflow_dispatch, pull_request, and schedule).

Job steps and linting improvements:

• The step that used the PSModule/GitHub-Script@v1 action to list files and commit documentation changes has been removed, simplifying the workflow.
• The Lint documentation step now uses super-linter/slim@v8.1.0 instead of a pinned commit from v8.2.0, and several new environment variables have been added to enable broader validation (VALIDATE_NATURAL_LANGUAGE, VALIDATE_ALL_CODEBASE, USE_FIND_ALGORITHM).

🩹[Patch]: Improve error handling and output error summary (#23)

Description

This pull request makes a minor improvement to error handling in the PowerShell documentation build script. Instead of writing errors as errors, it now logs them as warnings with more context when markdown help generation fails for a command.

• Improved error reporting by changing Write-Error to Write-Warning with a descriptive message in Build-PSModuleDocumentation.ps1.

🩹 [Patch]: Enhance error handling and summary reporting in documentation generation (#22)

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.

🪲 [Fix]: Fix so files are back to expected structure (#21)

Description

This pull request refactors the Build-PSModuleDocumentation.ps1 script to consistently use the $docsOutputFolder variable instead of $DocsOutputFolder or $moduleDocsFolder, and improves output formatting for command status messages. These changes help standardize variable usage and enhance script readability and maintainability.

Refactoring for variable consistency:

• Replaced all instances of $DocsOutputFolder and $moduleDocsFolder with $docsOutputFolder throughout the script to ensure consistent variable usage for documentation output paths. [1] [2] [3]

Output and formatting improvements:

• Updated status message output to use $PSStyle.Foreground.Green and $PSStyle.Foreground.Red for colored checkmarks and crosses, improving readability of command results.
• Added a section to display all generated documentation files after creation, making it easier to verify output.

Minor improvements:

• Disabled verbose output when importing the module with Import-Module by setting -Verbose:$false, reducing unnecessary log noise.

🩹 [Patch]: Update to use Microsoft.PowerShell.PlatyPS for docs generation (#19)

Description

This pull request introduces several improvements to the documentation generation process, CI workflows, and PowerShell module metadata. The most significant changes include enhanced and more robust documentation generation, updates to GitHub Actions workflows for better security and linting, and improvements to module help comments for consistency.

Documentation generation improvements:

• The Build-PSModuleDocumentation.ps1 script now generates markdown help per command, handles documentation file organization to match source structure, and fixes frontmatter titles for compatibility. This makes the documentation process more robust and the output more consistent. [1] [2]
• The script now uses the full module name Microsoft.PowerShell.PlatyPS for installation, ensuring compatibility.

GitHub Actions workflow enhancements:

• The Action-Test.yml workflow now requests explicit permissions for reading contents and writing statuses, uses a full-depth fetch for checkouts, logs file changes, commits documentation updates, and adds a markdown linter step. [1] [2] [3]
• The Linter.yml workflow disables certain linters for performance and disables credential persistence for increased security. [1] [2]

PowerShell module metadata improvements:

• Added .DESCRIPTION sections to all module functions for better help output, and added .NOTES with control instructions to Set-PSModuleTest and its corresponding public function. [1] [2] [3] [4] [5]

Link: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.platyps/new-markdowncommandhelp?view=ps-modules