v1.0.6

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

v1.0.5

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

v1.0.4

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

v1.0.3

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

v1.0.2

🩹 [Patch]: Update Dependabot configuration to include labels for GitHub Actions (#18)

Description

This pull request makes a small configuration update to Dependabot. It adds default labels to pull requests created for GitHub Actions updates.

• Added dependencies and github-actions labels to Dependabot PRs for GitHub Actions updates in .github/dependabot.yml.

v1.0.1

Bump actions/checkout from 4 to 5 (#17)

Bumps actions/checkout from 4 to 5.

Release notes

Sourced from actions/checkout's releases.

v5.0.0

What's Changed

• Update actions checkout to use node 24 by @​salmanmkc in actions/checkout#2226
• Prepare v5.0.0 release by @​salmanmkc in actions/checkout#2238

⚠️ Minimum Compatible Runner Version

v2.327.1
Release Notes

Make sure your runner is updated to this version or newer to use this release.

Full Changelog: actions/checkout@v4...v5.0.0

v4.3.0

What's Changed

• docs: update README.md by @​motss in actions/checkout#1971
• Add internal repos for checking out multiple repositories by @​mouismail in actions/checkout#1977
• Documentation update - add recommended permissions to Readme by @​benwells in actions/checkout#2043
• Adjust positioning of user email note and permissions heading by @​joshmgross in actions/checkout#2044
• Update README.md by @​nebuk89 in actions/checkout#2194
• Update CODEOWNERS for actions by @​TingluoHuang in actions/checkout#2224
• Update package dependencies by @​salmanmkc in actions/checkout#2236
• Prepare release v4.3.0 by @​salmanmkc in actions/checkout#2237

New Contributors

• @​motss made their first contribution in actions/checkout#1971
• @​mouismail made their first contribution in actions/checkout#1977
• @​benwells made their first contribution in actions/checkout#2043
• @​nebuk89 made their first contribution in actions/checkout#2194
• @​salmanmkc made their first contribution in actions/checkout#2236

Full Changelog: actions/checkout@v4...v4.3.0

v4.2.2

What's Changed

• url-helper.ts now leverages well-known environment variables by @​jww3 in actions/checkout#1941
• Expand unit test coverage for isGhes by @​jww3 in actions/checkout#1946

Full Changelog: actions/checkout@v4.2.1...v4.2.2

v4.2.1

What's Changed

• Check out other refs/* by commit if provided, fall back to ref by @​orhantoy in actions/checkout#1924

New Contributors

• @​Jcambass made their first contribution in actions/checkout#1919

Full Changelog: actions/checkout@v4.2.0...v4.2.1

... (truncated)

Changelog

Sourced from actions/checkout's changelog.

Changelog

V5.0.0

• Update actions checkout to use node 24 by @​salmanmkc in actions/checkout#2226

V4.3.0

• docs: update README.md by @​motss in actions/checkout#1971
• Add internal repos for checking out multiple repositories by @​mouismail in actions/checkout#1977
• Documentation update - add recommended permissions to Readme by @​benwells in actions/checkout#2043
• Adjust positioning of user email note and permissions heading by @​joshmgross in actions/checkout#2044
• Update README.md by @​nebuk89 in actions/checkout#2194
• Update CODEOWNERS for actions by @​TingluoHuang in actions/checkout#2224
• Update package dependencies by @​salmanmkc in actions/checkout#2236

v4.2.2

• url-helper.ts now leverages well-known environment variables by @​jww3 in actions/checkout#1941
• Expand unit test coverage for isGhes by @​jww3 in actions/checkout#1946

v4.2.1

• Check out other refs/* by commit if provided, fall back to ref by @​orhantoy in actions/checkout#1924

v4.2.0

• Add Ref and Commit outputs by @​lucacome in actions/checkout#1180
• Dependency updates by @​dependabot- actions/checkout#1777, actions/checkout#1872

v4.1.7

• Bump the minor-npm-dependencies group across 1 directory with 4 updates by @​dependabot in actions/checkout#1739
• Bump actions/checkout from 3 to 4 by @​dependabot in actions/checkout#1697
• Check out other refs/* by commit by @​orhantoy in actions/checkout#1774
• Pin actions/checkout's own workflows to a known, good, stable version. by @​jww3 in actions/checkout#1776

v4.1.6

• Check platform to set archive extension appropriately by @​cory-miller in actions/checkout#1732

v4.1.5

• Update NPM dependencie...

v1.0.0

What's Changed

🌟 Breaking Changes

• 🌟 [Major]: Introducing Document-PSModule by @MariusStorhaug in #16

Full Changelog: v0...v1.0.0

v0.0.3

What's Changed

Other Changes

• 🩹 [Patch]: Add linter configurations and update .gitignore for VS Code by @MariusStorhaug in #15

Full Changelog: v0...v0.0.3

v0.0.2

What's Changed

Other Changes

• 🩹 [Patch]: Cleanup code that is managed in Build-PSModule by @MariusStorhaug in #14

Full Changelog: v0...v0.0.2

v0.0.1

What's Changed

Other Changes

• Add initial test configurations, modules, and functions by @MariusStorhaug in #13

New Contributors

• @MariusStorhaug made their first contribution in #13

Full Changelog: https://github.com/PSModule/Document-PSModule/commits/v0.0.1